Skip to content

Commit 6387cb7

Browse files
authored
PR must fail when generated code is not committed (#704)
When some code are changed by modifying code generator or templates, forgetting to commit the expected changes can lead to mistakes. I want to enforce that the PR author commits the generated code, by causing the CI to fail if the generated code is not committed. This PR achieves that.
1 parent cd97fa7 commit 6387cb7

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

.github/workflows/generated-code.yml

+8-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ name: Generate code and open pull request
22

33
on:
44
workflow_dispatch:
5+
pull_request:
56
push:
67
branches:
78
- master
@@ -27,7 +28,13 @@ jobs:
2728
diff=$(git --no-pager diff --name-only HEAD)
2829
echo "DIFF_IS_EMPTY=$([[ -z "$diff" ]] && echo 'true' || echo 'false')" >> $GITHUB_ENV
2930
echo "CURRENT_DATETIME=$(date +'%Y%m%d%H%M%S')" >> $GITHUB_ENV
30-
- if: ${{ env.DIFF_IS_EMPTY != 'true' }}
31+
## Run if diff exists and pull request, and make CI status failure
32+
- if: ${{ github.event_name == 'pull_request' && env.DIFF_IS_EMPTY != 'true' }}
33+
run: |
34+
echo "There are changes in the generated codes. Please run 'generate-code.py' and commit the changes." >&2
35+
exit 1
36+
## Run if diff exists and event is not pull request, and make PR
37+
- if: ${{ github.event_name != 'pull_request' && env.DIFF_IS_EMPTY != 'true' }}
3138
run: |
3239
git config user.name github-actions
3340
git config user.email [email protected]

0 commit comments

Comments
 (0)