[Chore] CI/CD for recce cloud compatible output #36
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Jaffle Shop Recce CI | |
| on: | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| check-pull-request: | |
| name: Check pull request by Recce CI | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10.x" | |
| - name: Install dependencies | |
| run: | | |
| pip install -r requirements.txt | |
| - name: Install Recce | |
| run: | | |
| pip install recce | |
| - name: Prepare dbt Base environment | |
| run: | | |
| gh repo set-default ${{ github.repository }} | |
| run_id=$(gh run list --workflow ${WORKFLOW_BASE} --status success --limit 1 --json databaseId --jq '.[0].databaseId') | |
| gh run download $run_id -n target -D target-download | |
| gh run download $run_id -n duckdb | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| WORKFLOW_BASE: ".github/workflows/dbt_base.yml" | |
| - name: Prepare dbt Current environment | |
| run: | | |
| git checkout ${{ github.event.pull_request.head.sha }} | |
| dbt deps | |
| dbt seed --target ${{ env.DBT_CURRENT_TARGET}} | |
| dbt run --target ${{ env.DBT_CURRENT_TARGET}} | |
| dbt docs generate --target ${{ env.DBT_CURRENT_TARGET}} | |
| env: | |
| DBT_CURRENT_TARGET: "dev" | |
| - name: Run Recce CI | |
| run: | | |
| recce run --github-pull-request-url ${{ github.event.pull_request.html_url }} | |
| - name: Archive Recce State File | |
| uses: actions/upload-artifact@v4 | |
| id: recce-artifact-uploader | |
| with: | |
| name: recce-state-file | |
| path: recce_state.json | |
| - name: Prepare Recce Summary | |
| id: recce-summary | |
| run: | | |
| recce summary recce_state.json > recce_summary.md | |
| cat recce_summary.md >> $GITHUB_STEP_SUMMARY | |
| echo '${{ env.NEXT_STEP_MESSAGE }}' >> recce_summary.md | |
| # Handle the case when the recce summary is too long to be displayed in the GitHub PR comment | |
| if [[ `wc -c recce_summary.md | awk '{print $1}'` -ge '65535' ]]; then | |
| echo '# Recce Summary | |
| The recce summary is too long to be displayed in the GitHub PR comment. | |
| Please check the summary detail in the [Job Summary](${{github.server_url}}/${{github.repository}}/actions/runs/${{github.run_id}}) page. | |
| ${{ env.NEXT_STEP_MESSAGE }}' > recce_summary.md | |
| fi | |
| env: | |
| ARTIFACT_URL: ${{ steps.recce-artifact-uploader.outputs.artifact-url }} | |
| NEXT_STEP_MESSAGE: | | |
| ## Next Steps | |
| If you want to check more detail inforamtion about the recce result, please download the [artifact](${{ steps.recce-artifact-uploader.outputs.artifact-url }}) file and open it by [Recce](https://pypi.org/project/recce/) CLI. | |
| ### How to check the recce result | |
| ```bash | |
| # Unzip the downloaded artifact file | |
| tar -xf recce-state-file.zip | |
| # Launch the recce server based on the state file | |
| recce server --review recce_state.json | |
| # Open the recce server http://localhost:8000 by your browser | |
| ``` | |
| - name: Comment on pull request | |
| uses: thollander/actions-comment-pull-request@v2 | |
| with: | |
| filePath: recce_summary.md |