Skip to content

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

Merged
merged 1 commit into from
Oct 23, 2020
Merged

Conversation

sayboras
Copy link
Member

@sayboras sayboras commented Oct 23, 2020

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

@@ -690,7 +690,3 @@ spec:
       - configMap:
           name: cilium-config
         name: cilium-config-path
-
-
-
please run 'make -C install/kubernetes quick-install' and submit your changes
Error: Process completed with exit code 1.
ci: Print hint to fix auto-generated file checks

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Oct 23, 2020
@sayboras sayboras added area/CI Continuous Integration testing issue or flake release-note/ci This PR makes changes to the CI. labels Oct 23, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Oct 23, 2020
@sayboras sayboras marked this pull request as ready for review October 23, 2020 07:56
@sayboras sayboras requested a review from a team as a code owner October 23, 2020 07:56
Copy link
Contributor

@kkourt kkourt left a 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! 🚀

@sayboras
Copy link
Member Author

Mark ready to merge as changes are only for github action (e.g. full ci is not required).

@sayboras sayboras added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Oct 23, 2020
@@ -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)
Copy link
Member

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?

Suggested change
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)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good pick, thanks 💯

@aanm aanm removed the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Oct 23, 2020
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]>
@kkourt kkourt added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Oct 23, 2020
@aanm aanm merged commit 72c1073 into cilium:master Oct 23, 2020
@sayboras sayboras deleted the ci/hint branch October 23, 2020 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/CI Continuous Integration testing issue or flake ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/ci This PR makes changes to the CI.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants