-
Notifications
You must be signed in to change notification settings - Fork 1
Fix docker image labels #288
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
Conversation
This file contains hidden or 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
9d047c4 to
034d5f1
Compare
jtherrmann
reviewed
May 15, 2025
Contributor
|
Additional testing screenshots in this thread: https://chat.asf.alaska.edu/asf/pl/kykwargec7y1dcn1r96hiryojy |
Co-authored-by: Jake Herrmann <jtherrmann@alaska.edu>
jtherrmann
reviewed
May 15, 2025
jtherrmann
reviewed
May 15, 2025
jtherrmann
reviewed
May 15, 2025
jtherrmann
reviewed
May 15, 2025
jtherrmann
reviewed
May 15, 2025
jtherrmann
reviewed
May 15, 2025
Co-authored-by: Jake Herrmann <jtherrmann@alaska.edu>
Co-authored-by: Jake Herrmann <jtherrmann@alaska.edu>
jtherrmann
approved these changes
May 16, 2025
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.
Before this PR our images labels after a release typically looked like:

which is less than desirable (see #278 for details). After this PR, image labels instead should look like:

This has been facilitated by switching to a version-number-centric workflow instead of branch-centric workflow and taking advantage of GitHub's workflow concurrency groups.
Notably:
version_tagpassed to the dockerize workflows must conform to PEP 440version_tag, but the workflow will only allow one concurrent execution per uniqueversion_tagtesttags will be applied to pushes of developmental versionslatesttags will be applied to pushes of all non-developmental versions (releases).The main departure from the expectation (not reality) of our previous workflows is that, for normal releases from the HEAD of the development branch, the
testtag will get "left behind" on that HEAD commit when the develop->main merge commit is fast-forwarded back to develop, so you won't see an images taggedvX.Y.Z,latest, andtestat the same time. This, I think, is fine, and facilitates hotfix releases (e.g., workflow won't pull test back from develop to the new tag)You can see my testing of it from a feature branch -> develop -> main -> release in ASFHyP3/hyp3-test-cookiecutter, starting with ASFHyP3/hyp3-test-cookiecutter#6 and the subsequent release PR ASFHyP3/hyp3-test-cookiecutter#5.
Important
These proposed changes allow for bumpless "releases" (really, it's only a merge to main) as long as we don't trigger on pushes to main (or really, any not-develop branch)! (This means a bumpless merge to main won't have a container built for it.) Otherwise, the version number computed for the bumpless merge commit on main will be a development version number and pull the 'test' tag to the main branch.
While not required, I think we should consider disallowing bumpless merges and/or switch to post-releases for that use case. Main really only serves to facilitate release PRs, which require a release branch, and I cannot think of a reason to have commits on main that aren't release merge commits (I went back through our bumpless releases and don't see any significant utility to them).
Post-releases would also solve the problems I got hung up on here: #234
This PR also:
reusable-git-object-name.ymlworkflow as it does not produce PEP 440 compliant version numbers and is currently only used within theupdate-examples.ymlworkflow in this repo across all of GitHub.updates-examples.ymlworkflow to not depend onreusable-git-object-name.yamlFixes #278