-
Notifications
You must be signed in to change notification settings - Fork 191
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
docs: extend development documentation #505
Conversation
Set the name of the container image to be created from the source code. This will be used | ||
when building, pushing and referring to the image on YAML files. | ||
|
||
```sh |
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.
The alternative shorter way of the below multi-step instruction is the following:
$ IMG=container-registry.com/yourhandle/source-controller TAG=latest BUILD_ARGS=--push \
make docker-build
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.
Nice one, I added this as well as the longer version.
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 a lot and 🍎 for first contribution 🙇
Tiny suggestion on the multi-step instruction that can make more efficient use of the available flags in the Makefile
. However, I think for documentation purposes the image related variables may still be exported as it provides a better visual separation. We may want to ensure the contributor knows in this case they can be passed as arguments as well.
(The other variable we may want to document is BUILD_PLATFORMS
, as it can be trimmed down to the user their specific target architecture for faster builds (and support for BUILDS_ARGS=--load
for single architecture images).)
Thank you for the review @hiddeco. I fixed the points you highlighted, PTAL. |
Needs a little rebase before it can be merged. |
Signed-off-by: Paulo Gomes <paulo.gomes@weave.works>
Fixes #454.
Ubuntu 20.04
.make test
to run.