-
Notifications
You must be signed in to change notification settings - Fork 3.4k
ci: Print hint to fix auto-generated file checks #13718
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this! 🚀
Mark ready to merge as changes are only for github action (e.g. full ci is not required). |
.github/workflows/smoke-test.yaml
Outdated
@@ -47,7 +47,7 @@ jobs: | |||
- name: Run helm-docs | |||
run: | | |||
make -C install/kubernetes docs | |||
git diff --exit-code | |||
git diff --exit-code || (echo "please run 'make -C install/kubernetes docs' and check in files"; exit 1) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: all other messages say "...and submit your changes" here. Maybe change it as well to stay consistent?
git diff --exit-code || (echo "please run 'make -C install/kubernetes docs' and check in files"; exit 1) | |
git diff --exit-code || (echo "please run 'make -C install/kubernetes docs' and submit your changes"; exit 1) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good pick, thanks 💯
This commit is to print step on how to fix github action check for generated files. This will surely help new contributors to have better experience and reduce feedback loop. Suggested by: Kornilios Kourtis <[email protected]> Signed-off-by: Tam Mach <[email protected]>
Description
ci(gha): Print hint to fix generated file check
This commit is to print steps on how to fix github action check for
generated files. This will surely help new contributors to have
better experience and reduce feedback loop.
Suggested by: Kornilios Kourtis [email protected]
Signed-off-by: Tam Mach [email protected]
Testing
Testing was done by one dummy change in one of the file https://github.com/cilium/cilium/pull/13718/checks?check_run_id=1296840070