Skip to content

docs: Have Makefile print generated image tags when running with V=0 #27250

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
Aug 4, 2023

Conversation

qmonnet
Copy link
Member

@qmonnet qmonnet commented Aug 3, 2023

When building Docker images for documentation with V=0, the Makefile for documentation does not print the name of the generated images.

One particular example of calling the Makefile with V=0 is for Cilium's runtime tests in CI, with .travis/build.sh calling:

`V=0` make -j 2 --quiet

This calls the default target for Cilium's main Makefile, which relies (among others) on the postcheck target, which in turns calls the check target from Documentation/Makefile, passing the V=0 flag. The absence of the docs-builder string from the logs make it harder to figure out whether the workflow successfully built the image.

This commit simply adds the image tag (passed to Docker with --tag, but not actually containing the version tag) to the invocation of $(ECHO_DOCKER), so that Documentation/Makefile can print it when we request a non-verbose build with V=0.

@qmonnet qmonnet added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels Aug 3, 2023
@qmonnet qmonnet requested a review from a team as a code owner August 3, 2023 13:52
@qmonnet qmonnet requested a review from learnitall August 3, 2023 13:52

Verified

This commit was signed with the committer’s verified signature.
qmonnet Quentin Monnet
When building Docker images for documentation with V=0, the Makefile for
documentation does not print the name of the generated images.

One particular example of calling the Makefile with V=0 is for Cilium's
runtime tests in CI, with .travis/build.sh calling:

    V=0 make -j 2 --quiet

This calls the default target for Cilium's main Makefile, which relies
(among others) on the "postcheck" target, which in turns calls the
"check" target from Documentation/Makefile, passing the V=0 flag. The
absence of the "docs-builder" string from the logs make it harder to
figure out whether the workflow successfully built the image.

This commit simply adds the image tag (passed to Docker with "--tag",
but not actually containing the version tag) to the invocation of
$(ECHO_DOCKER), so that Documentation/Makefile can print it when we
request a non-verbose build with V=0.

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
@qmonnet qmonnet force-pushed the pr/docs-image-name branch from b99f5e0 to 803221a Compare August 3, 2023 13:57
@qmonnet
Copy link
Member Author

qmonnet commented Aug 3, 2023

/test

Copy link
Contributor

@learnitall learnitall left a comment

Choose a reason for hiding this comment

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

Nice!

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Aug 4, 2023
@qmonnet
Copy link
Member Author

qmonnet commented Aug 4, 2023

This probably doesn't matter too much for older branches, but I've tried to keep the doc framework mostly identical on all branches and this commit should be trivial to backport, so let's go for it.

@qmonnet qmonnet merged commit 7dc64d9 into cilium:main Aug 4, 2023
@qmonnet qmonnet deleted the pr/docs-image-name branch August 4, 2023 20:20
@joamaki joamaki mentioned this pull request Aug 8, 2023
9 tasks
@joamaki joamaki added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. and removed needs-backport/1.14 backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. labels Aug 8, 2023
@joamaki joamaki mentioned this pull request Aug 9, 2023
9 tasks
@joamaki joamaki mentioned this pull request Aug 9, 2023
7 tasks
@YutaroHayakawa YutaroHayakawa added the backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. label Aug 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
Status: Released
Status: Released
Development

Successfully merging this pull request may close these issues.

None yet

5 participants