build: INFENG-933: add GitHub action to start a minor release #10112
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
Add GitHub action to start a minor release. This is necessary, temporarily, to run both lock-api-state.sh and lock-published-urls.sh, until we can figure out a way to make those same guarantees without committing directly to main every time we do a minor release. This basically just reproduces a small part of rph, but with GitHub actions instead.
Add steps to install Go and the buf/protobuf dependencies. Add some helpful newlines for readability.
output something helpful if an error occurs.
Add ::error:: to error output on version string validation step.
✅ Deploy Preview for determined-ui canceled.
|
dannysauer
reviewed
Oct 23, 2024
dannysauer
reviewed
Oct 23, 2024
Comment on lines
20
to
26
| grep -E -o '[0-9]+\.[0-9]+\.0' <(printf "%s" '${{ github.event.inputs.version }}') | ||
|
|
||
| ret=$? | ||
| if [[ $ret != 0 ]]; then | ||
| echo '::error::Version string must match <[0-9]+\.[0-9]+\.0>. Got: <${{ github.event.inputs.version }}>' | ||
| exit $ret | ||
| fi |
There was a problem hiding this comment.
Since you're setting the shell to bash, you can technically just use bash pattern matching. Just think of the amazing speed improvement when you don't need a subshell and a fork!
Suggested change
| grep -E -o '[0-9]+\.[0-9]+\.0' <(printf "%s" '${{ github.event.inputs.version }}') | |
| ret=$? | |
| if [[ $ret != 0 ]]; then | |
| echo '::error::Version string must match <[0-9]+\.[0-9]+\.0>. Got: <${{ github.event.inputs.version }}>' | |
| exit $ret | |
| fi | |
| shopt -s extglob | |
| v='${{ github.event.inputs.version }}' | |
| if [[ "$v" != @(+(0-0).+(0-9).0) ]]; then | |
| echo '::error::Version string must match <[0-9]+\.[0-9]+\.0>. Got: <'"$v"'>' | |
| exit 1 | |
| fi |
Feel free to ignore this suggestion completely. People actually understand grep. :D
There was a problem hiding this comment.
Huh. Neat! I always learn something new about Bash from you.
dannysauer
reviewed
Oct 23, 2024
dannysauer
reviewed
Oct 23, 2024
Add GH_TOKEN env variable to use the DETERMINED_TOKEN secret, otherwise expect permissions issues when non-admins run the action. Add explicit contents: write permission.
thiagodallacqua-hpe
pushed a commit
that referenced
this pull request
Oct 28, 2024
thiagodallacqua-hpe
pushed a commit
that referenced
this pull request
Oct 28, 2024
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.
Ticket
INFENG-933
Description
This changeset introduces a new GitHub action,
start-minor-release.yml, which will, for the time being, be used to kick off minor releases. I'll explain why we need to do this, and then how.I wasn't quite able to eliminate all of the additional stateful commits that happen as part of the old release process in time for the upcoming release. What remains is two scripts that
rphused to run:lock-api-state.shandlock-published-urls.sh.lock-api-state.shgenerates a new buf image,proto/buf.image.bin, which is used ahead of subsequent releases to check for breaking API changes. I was unable to replace that in a way that sufficiently reproduced this functionality (e.g. with pre-commit). I believelock-published-urls.shwould be fine to run as part of every pre-commit check, or at least on every PR, but I also don't have time to test that out before the upcoming release, either.How this works is straightforward: the action validates the input version string, configures the git author information, sets up Go, installs buf/protobuf dependencies, creates a release branch with that version string, pushes it to
origin, checks out main, runs the two scripts mentioned above, then pushesmainback toorigin. These lines in rph, basically, albeit without runningbumpversion.Test Plan
GitHub actions are always tricky to test, especially this one, because it makes changes on main and creates a release branch. I did, however, test this out on the determined-dryrun repository, with the same GitHub action. You can see that the automation created a new release branch,
release-0.39.0, and then made the two requisite commits on main forlock-api-state.shandlock-published-urls.sh, complete with similar changes that will get made for the upcoming production release.Checklist
docs/release-notes/See Release Note for details.