Add Release PR actions #76
Merged
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
samuelburnham
force-pushed
the
release-workflow
branch
from
41bdcab
to
09c214d
Compare
samuelburnham
force-pushed
the
release-workflow
branch
from
09c214d
to
a12b9fc
Compare
This was referenced Sep 20, 2024
tchataigner
previously approved these changes
Sep 23, 2024
| GITHUB_TOKEN: ${{ inputs.token }} | ||
| shell: bash | ||
|
|
||
| # Include the full patch version in the PR branch name if a patch, otherwise call it `release-pr` for a major or minor release |
There was a problem hiding this comment.
It might also be interesting to have different names for release branches as some repositories might have multiple releases of major/minor that could be triggered in parallel.
If that's too bothersome we'll just constrain ourselves to keep it to one at a time.
huitseeker
reviewed
Sep 23, 2024
| git push origin $TAG_VERSION --follow-tags | ||
| echo "tag-version=$TAG_VERSION" | tee -a "$GITHUB_OUTPUT" | ||
| shell: bash | ||
|
|
There was a problem hiding this comment.
I would consider either testing the length of the get-version or making the subsequent steps conditional on if: steps.get-version.outputs.tag-version != ''
| D='0|[1-9][0-9]*' | ||
| PW='[0-9]*[a-zA-Z-][0-9a-zA-Z-]*' | ||
| MW='[0-9a-zA-Z-]+' | ||
| SEMVER_REGEX="^($D)\.($D)\.($D)(-(($D|$PW)(\.($D|$PW))*))?(\+($MW(\.$MW)*))?$" |
There was a problem hiding this comment.
I believe the official semver regex (from doc) is:
SEMVER_REGEX="^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+([0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*))?$"
This one had minor differences, are they important?
| # If major release, get latest minor release from prior major version | ||
| # If minor release, get latest minor release from given major version | ||
| if [[ "${{ inputs.release-type }}" == "major" || "${{ inputs.release-type }}" == "minor" ]]; then | ||
| set +o pipefail |
| id: get-latest-release | ||
| run: | | ||
| set +o pipefail | ||
| LATEST_RELEASE=$(gh release list --repo ${{ github.repository }} --limit 100 | grep -Ei "${{ inputs.tag-prefix }}" | head -n 1 | awk '{ print $1 }') |
huitseeker
previously approved these changes
Sep 24, 2024
samuelburnham
force-pushed
the
release-workflow
branch
2 times, most recently
from
9c6136f
to
ba95e81
Compare
samuelburnham
force-pushed
the
release-workflow
branch
from
ba95e81
to
fbc79c1
Compare
huitseeker
approved these changes
Sep 25, 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.
Adds composite actions for an automated release PR and associated tag + GitHub release when the release PR is merged. Builds on prior work in collaboration with @tchataigner (1, 2)
release-pr.ymlMajor/minor release
workflow_dispatch, withmajororminoras therelease-typeinputrelease/<tag-prefix>-v<version>branch, e.g.release/aptos-v1.0. Note thatrelease/branches omit the SemVer patch version, as they are meant to persist for production and will iteratively incorporate any patches/hotfixes.release/aptos-v1.1release-prthat increments the version number inCargo.toml, e.g.1.0.0to1.1.0release-prto the newrelease/branch. This allows for CI, PR review, and any additional commits to be added for the release. These commits should generally be cherry-picked from existing commits to the default branch.tag-releaseworkflow. Therelease-prbranch can be safely deleted, but therelease/branch should be kept as the release source.Patch release
workflow_dispatch, withpatchas therelease-typeinputrelease/<tag-prefix>-v<version>branch, e.g.release/aptos-v1.0patch/<tag-prefix>-v<version>.<patch-version>, e.g.patch/aptos-v1.0.1, which increments the version number inCargo.tomlaccordinglypatch/branch to the newrelease/branch. This allows for CI, PR review, and any additional commits to be added for the release.tag-releaseworkflow. Thepatch/branch can be safely deleted, but therelease/branch should be kept as the release source.tag-release.ymlrelease-prcaller when the release PR is merged, as it relies on the head and base branch names for tagging.Downstream examples
Successful runs
TODOs
Cargo.tomlversion if this is the latestmajor.minorrelease