Report API Diff #243
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: Report API Diff | |
| on: | |
| workflow_run: | |
| types: [completed] | |
| workflows: | |
| - Get api.json from CherryPick # get-api-diff.yml | |
| jobs: | |
| compare-diff: | |
| runs-on: ubuntu-latest | |
| if: ${{ github.event.workflow_run.conclusion == 'success' }} | |
| permissions: | |
| pull-requests: write | |
| # api-artifact | |
| steps: | |
| - name: Download artifact | |
| uses: actions/[email protected] | |
| with: | |
| script: | | |
| const fs = require('fs'); | |
| let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| run_id: context.payload.workflow_run.id, | |
| }); | |
| let matchArtifacts = allArtifacts.data.artifacts.filter((artifact) => { | |
| return artifact.name.startsWith("api-artifact-") || artifact.name == "api-artifact" | |
| }); | |
| await Promise.all(matchArtifacts.map(async (artifact) => { | |
| let download = await github.rest.actions.downloadArtifact({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| artifact_id: artifact.id, | |
| archive_format: 'zip', | |
| }); | |
| await fs.promises.writeFile(`${process.env.GITHUB_WORKSPACE}/${artifact.name}.zip`, Buffer.from(download.data)); | |
| })); | |
| - name: Extract all artifacts | |
| run: | | |
| find . -mindepth 1 -maxdepth 1 -type f -name '*.zip' -exec unzip {} -d artifacts ';' | |
| ls -la | |
| - name: Load PR Number | |
| id: load-pr-num | |
| run: echo "pr-number=$(cat artifacts/pr_number)" >> "$GITHUB_OUTPUT" | |
| - name: Output base | |
| run: cat ./artifacts/api-base.json | |
| - name: Output head | |
| run: cat ./artifacts/api-head.json | |
| - name: Arrange json files | |
| run: | | |
| jq '.' ./artifacts/api-base.json > ./api-base.json | |
| jq '.' ./artifacts/api-head.json > ./api-head.json | |
| - name: Get diff of 2 files | |
| run: diff -u --label=base --label=head ./api-base.json ./api-head.json | cat > api.json.diff | |
| - name: Get full diff | |
| run: diff --label=base --label=head --new-line-format='+%L' --old-line-format='-%L' --unchanged-line-format=' %L' ./api-base.json ./api-head.json | cat > api-full.json.diff | |
| - name: Echo full diff | |
| run: cat ./api-full.json.diff | |
| - name: Upload full diff to Artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: api-artifact | |
| path: | | |
| api-full.json.diff | |
| api-base.json | |
| api-head.json | |
| - id: out-diff | |
| name: Build diff Comment | |
| run: | | |
| HEADER="이 PR에 의한 api.json 차이" | |
| FOOTER="[Get diff files from Workflow Page](https://github.com/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID})" | |
| DIFF_BYTES="$(stat ./api.json.diff -c '%s' | tr -d '\n')" | |
| echo "$HEADER" > ./output.md | |
| if (( "$DIFF_BYTES" <= 1 )); then | |
| echo '차이점이 없습니다.' >> ./output.md | |
| else | |
| echo '<details>' >> ./output.md | |
| echo '<summary>차이점은 여기에서 볼 수 있음</summary>' >> ./output.md | |
| echo >> ./output.md | |
| echo '```diff' >> ./output.md | |
| cat ./api.json.diff >> ./output.md | |
| echo '```' >> ./output.md | |
| echo '</details>' >> .output.md | |
| fi | |
| echo "$FOOTER" >> ./output.md | |
| - uses: thollander/actions-comment-pull-request@v2 | |
| with: | |
| pr_number: ${{ steps.load-pr-num.outputs.pr-number }} | |
| comment_tag: show_diff | |
| filePath: ./output.md | |
| - name: Tell error to PR | |
| uses: thollander/actions-comment-pull-request@v2 | |
| if: failure() && steps.load-pr-num.outputs.pr-number | |
| with: | |
| pr_number: ${{ steps.load-pr-num.outputs.pr-number }} | |
| comment_tag: show_diff_error | |
| message: | | |
| api.json 간 차이점을 생성하는 도중 오류가 발생했습니다. 자세한 내용은 [Workflow 로그](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})를 확인해 주세요. |