-
Notifications
You must be signed in to change notification settings - Fork 1.8k
cherry pick: Version and release documentation (#531) #604
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
cherry pick: Version and release documentation (#531) #604
Conversation
* .gitignore,Makefile: added 'build' Makefile target to build a binary within project context (in 'build' dir), and .gitignore clause * doc/release-versioning.md: rough draft of release and versioning semantics and mechanics * Makefile: add mutiple build targets and reformat 'all' make target * release.sh: tag and build release with a few pre-build checks * Makefile: added signature make targets to run under release target * doc/release-versioning.md: revised release process such that 'release.sh' automates everything from building multi-arch to signing * Makefile: add '--tags' flag when retrieving version so the current tag is retrieved regardless of signature * Makefile: ensure git and gpg are configured to have the same signing key * doc/release-versioning.md: document supported k8s versions, architectures, and platforms in their own section * release.sh,Makefile,pkg/generator/templates.go: check versions before tagging on release
release.sh
Outdated
| TOML_TMPL_FILE="pkg/generator/templates.go" | ||
| CURR_VER_VER_FILE="$(sed -nr 's/Version = "(.+)"/\1/p' "$VER_FILE" | tr -d '\s\t\n')" | ||
| CURR_VER_TMPL_FILE="$(sed -nr 's/.*".*v(.+)".*#osdk_version_annotation/v\1/p' "$TOML_TMPL_FILE" | tr -d '\s\t\n')" | ||
| if [ "$CURR_VER" != "$CURR_VER_VER_FILE" ] \ |
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.
This should be comparing the desired version with verison.go. if [ "$VER" != "$CURR_VER_VER_FILE" ]
Say I'm trying to cut the tag for v0.0.7 and I've updated version.go and Gopkg.toml to v0.0.7.
But before this script can actually cut the tag, my current tag would be v0.0.6.
The current tag is something the script would update. The check should be to make sure version.go and Gopkg.toml are already updated to use the desired $VER.
446ddea to
32f9916
Compare
AlexNPavel
left a comment
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.
I think this is ready to merge now. The changes made here should also be backported to the master branch before doing the v0.0.7 release to make sure we can do a proper release on master before rebasing this branch over master.
… (operator-framework#604) * .gitignore,Makefile: added 'build' Makefile target to build a binary within project context (in 'build' dir), and .gitignore clause * Makefile: add mutiple build targets and reformat 'all' make target * Makefile: added signature make targets to run under release target * Makefile: ensure git and gpg are configured to have the same signing key * doc/release-versioning.md: document supported k8s versions, architectures, and platforms in their own section * release.sh,Makefile,pkg/generator/templates.go: check versions before tagging on release
* .gitignore,Makefile: added 'build' Makefile target to build a binary within project context (in 'build' dir), and .gitignore clause * Makefile: add mutiple build targets and reformat 'all' make target * Makefile: added signature make targets to run under release target * Makefile: ensure git and gpg are configured to have the same signing key * doc/release-versioning.md: document supported k8s versions, architectures, and platforms in their own section * release.sh,Makefile,pkg/generator/templates.go: check versions before tagging on release
Has useful annotations and makes the build workflow a bit easier.