docs: Have Makefile print generated image tags when running with V=0 #27250
Conversation
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
qmonnet
added
area/documentation
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
force-pushed
the
pr/docs-image-name
branch
from
b99f5e0
to
803221a
Compare
|
/test |
maintainer-s-little-helper
bot
added
the
ready-to-merge
|
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
added
needs-backport/1.12
needs-backport/1.13
joamaki
added
backport-pending/1.14
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.14
in 1.14.1
joamaki
added
backport-done/1.14
maintainer-s-little-helper
bot
moved this from Backport pending to v1.14
to Backport done to v1.14
in 1.14.1
joamaki
added
backport-pending/1.13
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.13
in 1.13.6
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.12
in 1.12.13
maintainer-s-little-helper
bot
moved this from Backport pending to v1.12
to Needs backport from main
in 1.12.13
YutaroHayakawa
added
backport-done/1.13
joestringer
moved this from Needs backport from main
to Backport done to v1.12
in 1.12.14
This was referenced Sep 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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=0is for Cilium's runtime tests in CI, with .travis/build.sh calling:This calls the default target for Cilium's main Makefile, which relies (among others) on the
postchecktarget, which in turns calls thechecktarget from Documentation/Makefile, passing theV=0flag. The absence of thedocs-builderstring 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 withV=0.