Skip to content

Commit

Permalink
Merge pull request #47 from DataRecce/feature/recce-cloud-with-recce-…
Browse files Browse the repository at this point in the history
…oss-cloud-mode

Update the recce cloud setup steps
  • Loading branch information
popcornylu authored Jun 20, 2024
2 parents 8544122 + 520836c commit de43bd0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/docs/recce-cloud/setup-gh-actions-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ myprofile:

### GitHub Token

Currenlty, we use the GitHub token as the cloud token. Put your github token to the [GitHub Actions Secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)
Currently, we use the GitHub token as the cloud token. Put your github token to the [GitHub Actions Secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)

In the below example, we use the secret named `RECCE_CLOUD_TOKEN`


!!!Note

You cannot use the [automatic generated token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) here, because we need the personal access token (PAT) to verify if the user has PUSH permission of the repository.
You cannot use the [automatic generated token](https://docs.github.com/en/actions/security-guides/ automatic-token-authentication) here, because we need the personal access token (PAT) to verify if the user has PUSH permission of the repository.

## Workflow Template

Expand Down
12 changes: 8 additions & 4 deletions docs/docs/recce-cloud/setup-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ Without Recce Cloud, we use the Recce State File to store PR review states. Howe

## Prerequisite

1. Prepare the github personal access token. Please see the [GitHub document](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
1. Prepare the github personal access token. Please see the [GitHub document](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). And set it to your environment variable.

```
export GITHUB_TOKEN=<token>
```

2. (Optional) Install the github cli. Please see the [GitHub CLI document](https://github.com/cli/cli)

Expand All @@ -29,7 +33,7 @@ Without Recce Cloud, we use the Recce State File to store PR review states. Howe
```
1. Launch the recce server in the cloud mode. It will use the dbt artifacts in the local `target` and `target-base` and initiate a new review state if necessary.
```
recce server --cloud --cloud-token <GITHUB_TOKEN>
recce server --cloud
```

### Execute the `recce run` in the cloud mode
Expand All @@ -44,7 +48,7 @@ In general, recce run is used in CI/CD or automation environments. We can use re
1. Prepare dbt artifacts for the base (`target-base/`) and current (`target/`) environments.
1. Execute the recce run in the cloud mode. It will use the dbt artifacts in the local `target` and `target-base` and initiate a new review state if necessary.
```
recce run --cloud --cloud-token <GITHUB_TOKEN>
recce run --cloud
```

### Review in the `recce server` in the cloud mode
Expand All @@ -57,7 +61,7 @@ If the review state is already available for this PR, you can open the recce ser
1. Launch the recce server to review this PR
```
recce server --review --cloud --cloud-token <GITHUB_TOKEN>
recce server --review --cloud
```
## Integrate the CI/CD workflow
Expand Down

0 comments on commit de43bd0

Please sign in to comment.