-
Notifications
You must be signed in to change notification settings - Fork 22
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
ci: Add bump version workflow for release tags #138
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,244 @@ | ||
| name: Bump version | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
| part: | ||
| description: 'Semver type of new version (major | minor | patch)' | ||
| required: true | ||
| type: choice | ||
| options: | ||
| - patch | ||
| - minor | ||
| - major | ||
| release_candidate: | ||
| type: choice | ||
| description: 'Release candidate?' | ||
| options: | ||
| - false | ||
| - true | ||
| new_version: | ||
| description: 'New version to bump to' | ||
| required: true | ||
| force: | ||
| type: choice | ||
| description: 'Force override check?' | ||
| options: | ||
| - false | ||
| - true | ||
| dry_run: | ||
| type: choice | ||
| description: 'Perform a dry run to check?' | ||
| options: | ||
| - true | ||
| - false | ||
|
|
||
| jobs: | ||
| bump-version: | ||
| runs-on: ubuntu-latest | ||
| if: github.repository == 'scikit-hep/pylhe' | ||
|
|
||
| steps: | ||
| # Use GitHub PAT to authenticate so other workflows trigger | ||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
| token: ${{ secrets.ACCESS_TOKEN }} | ||
matthewfeickert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - name: Verify new version bump step is valid | ||
| if: github.event.inputs.force == 'false' | ||
| id: script | ||
| shell: bash | ||
| run: | | ||
| current_tag="$(git describe --tags --abbrev=0)" | ||
| current_tag="${current_tag:1}" | ||
|
|
||
| latest_stable_tag="$(git tag | grep --invert-match 'rc' | tail -n 1)" | ||
| latest_stable_tag="${latest_stable_tag:1}" | ||
|
|
||
| echo "* Current version: ${current_tag}" | ||
| echo "* Latest stable version: ${latest_stable_tag}" | ||
|
|
||
| if [ ${{ github.event.inputs.release_candidate }} == 'true' ]; then | ||
| echo "* Attempting a ${{ github.event.inputs.part }} version release candidate bump from ${current_tag} to: ${{ github.event.inputs.new_version }}" | ||
| else | ||
| # For ease of use, set current tag to latest stable | ||
| current_tag="${latest_stable_tag}" | ||
|
|
||
| echo "* Attempting a ${{ github.event.inputs.part }} version bump from ${current_tag} to: ${{ github.event.inputs.new_version }}" | ||
| fi | ||
|
|
||
| echo "* Validating bump target version matches SemVer..." | ||
|
|
||
| # IFS is single charecter, so split on the 'r' in "rc" | ||
| IFS='r' read current_tag_read current_rc <<EOF | ||
| ${current_tag} | ||
| EOF | ||
| current_rc="${current_rc:1}" | ||
|
|
||
| IFS='.' read current_major current_minor current_patch <<EOF | ||
| ${current_tag_read} | ||
| EOF | ||
| # current_tag_read is read only and no longer used | ||
| unset current_tag_read | ||
|
|
||
| # IFS is single charecter, so split on the 'r' in "rc" | ||
| IFS='r' read bump_version bump_rc <<EOF | ||
| ${{ github.event.inputs.new_version }} | ||
| EOF | ||
| bump_rc="${bump_rc:1}" | ||
|
|
||
| # bump_version is a read only variable | ||
| IFS='.' read bump_major bump_minor bump_patch <<EOF | ||
| ${bump_version} | ||
| EOF | ||
| unset bump_version | ||
|
|
||
| # Check release candidates are valid before proceeding | ||
| if [ ${{ github.event.inputs.release_candidate }} == 'true' ]; then | ||
| if [ -z "${current_rc}" ]; then | ||
| current_rc=0 | ||
| fi | ||
| if [ "${bump_rc}" != "$((${current_rc} + 1))" ]; then | ||
| echo "ERROR: ${{ github.event.inputs.new_version }} is more than 1 release candidate version greater then ${current_tag}" | ||
| exit 1 | ||
| fi | ||
| else | ||
| if [ ! -z "${bump_rc}" ]; then | ||
| echo "ERROR: ${{ github.event.inputs.new_version }} contains a release candidate signature rc${bump_rc} but was marked as stable release." | ||
| exit 1 | ||
| fi | ||
| fi | ||
|
|
||
| if [ ${{ github.event.inputs.part }} == "major" ]; then | ||
| # Minor version should be zero | ||
| if [ "${bump_minor}" != "0" ]; then | ||
| echo "ERROR: ${{ github.event.inputs.part }} release attempted, ${{ github.event.inputs.new_version }} minor version should equal 0." | ||
| exit 1 | ||
| fi | ||
| # Patch version should be zero | ||
| if [ "${bump_patch}" != "0" ]; then | ||
| echo "ERROR: ${{ github.event.inputs.part }} release attempted, ${{ github.event.inputs.new_version }} patch version should equal 0." | ||
| exit 1 | ||
| fi | ||
| if [ "${bump_major}" != "$((${current_major} + 1))" ]; then | ||
| if ! ([ "${bump_major}" == "${current_major}" ] && [ ${{ github.event.inputs.release_candidate }} == 'true' ]); then | ||
| echo "ERROR: ${{ github.event.inputs.part }} release candidate release attempted, but ${{ github.event.inputs.new_version }} is more than 1 ${{ github.event.inputs.part }} version greater then ${current_tag}." | ||
| exit 1 | ||
| fi | ||
| fi | ||
| fi | ||
|
|
||
| if [ ${{ github.event.inputs.part }} == "minor" ]; then | ||
| # Major versions should be equal | ||
| if [ "${bump_major}" != "${current_major}" ]; then | ||
| echo "ERROR: ${{ github.event.inputs.part }} release attempted, but ${{ github.event.inputs.new_version }} major version not equal to ${current_tag}." | ||
| exit 1 | ||
| fi | ||
| # Patch version should be zero | ||
| if [ "${bump_patch}" != "0" ]; then | ||
| echo "ERROR: ${{ github.event.inputs.part }} release attempted, ${{ github.event.inputs.new_version }} patch version should equal 0." | ||
| exit 1 | ||
| fi | ||
| if [ "${bump_minor}" != "$((${current_minor} + 1))" ]; then | ||
| if ! ([ "${bump_minor}" == "${current_minor}" ] && [ ${{ github.event.inputs.release_candidate }} == 'true' ]); then | ||
| echo "ERROR: ${{ github.event.inputs.part }} release candidate release attempted, but ${{ github.event.inputs.new_version }} is more than 1 ${{ github.event.inputs.part }} version greater then ${current_tag}." | ||
| exit 1 | ||
| fi | ||
| fi | ||
| fi | ||
|
|
||
| if [ ${{ github.event.inputs.part }} == "patch" ]; then | ||
| # Major versions should be equal | ||
| if [ "${bump_major}" != "${current_major}" ]; then | ||
| echo "ERROR: ${{ github.event.inputs.part }} release attempted, but ${{ github.event.inputs.new_version }} major version not equal to ${current_tag}." | ||
| exit 1 | ||
| fi | ||
| # Minor versions should be equal | ||
| if [ "${bump_minor}" != "${current_minor}" ]; then | ||
| echo "ERROR: ${{ github.event.inputs.part }} release attempted, but ${{ github.event.inputs.new_version }} minor version not equal to ${current_tag}." | ||
| exit 1 | ||
| fi | ||
| if [ "${bump_patch}" != "$((${current_patch} + 1))" ]; then | ||
| if ! ([ "${bump_patch}" == "${current_patch}" ] && [ ${{ github.event.inputs.release_candidate }} == 'true' ]); then | ||
| echo "ERROR: ${{ github.event.inputs.part }} release candidate release attempted, but ${{ github.event.inputs.new_version }} is more than 1 ${{ github.event.inputs.part }} version greater then ${current_tag}." | ||
| exit 1 | ||
| fi | ||
| fi | ||
| fi | ||
|
|
||
| echo " ...version bump validated!" | ||
| if [ ${{ github.event.inputs.release_candidate }} == 'true' ]; then | ||
| echo "* Bumping version ${current_tag} to ${{ github.event.inputs.part }} version release candidate ${{ github.event.inputs.new_version }}" | ||
| else | ||
| echo "* Bumping version ${current_tag} to ${{ github.event.inputs.part }} version ${{ github.event.inputs.new_version }}" | ||
| fi | ||
|
|
||
| echo ::set-output name=old_tag::v${current_tag} | ||
|
|
||
| - name: Set up Python | ||
| if: success() | ||
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: '3.x' | ||
|
|
||
| - name: Install Python dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip setuptools wheel | ||
| python -m pip install tbump | ||
| python -m pip list | ||
|
|
||
| - name: Setup Git user to push new tag | ||
| run: | | ||
| git config --local user.email "action@github.com" | ||
| git config --local user.name "GitHub Action" | ||
|
|
||
| - name: Bump version and push to GitHub | ||
| if: >- | ||
| github.event_name == 'workflow_dispatch' | ||
| && ( | ||
| github.event.sender.login == 'lukasheinrich' || | ||
| github.event.sender.login == 'matthewfeickert' || | ||
| github.event.sender.login == 'eduardo-rodrigues' | ||
| ) | ||
| shell: bash | ||
| run: | | ||
| tbump --non-interactive --no-push ${{ github.event.inputs.new_version }} | ||
|
|
||
| - name: Update the Git tag annotation | ||
| if: ${{ github.event.inputs.dry_run }} == 'false' | ||
| shell: bash | ||
| run: | | ||
| OLD_TAG=${{ steps.script.outputs.old_tag }} | ||
| git tag -n99 --list "${OLD_TAG}" | ||
|
|
||
| NEW_TAG=v${{ github.event.inputs.new_version }} | ||
| git tag -n99 --list "${NEW_TAG}" | ||
|
|
||
| CHANGES=$(git log --pretty=format:'%s' "${OLD_TAG}"..HEAD --regexp-ignore-case --extended-regexp --grep='^([a-z]*?):') | ||
| CHANGES_NEWLINE="$(echo "${CHANGES}" | sed -e 's/^/ - /')" | ||
| SANITIZED_CHANGES=$(echo "${CHANGES}" | sed -e 's/^/<li>/' -e 's|$|</li>|' -e 's/(#[0-9]\+)//' -e 's/"/'"'"'/g') | ||
| NUM_CHANGES=$(echo -n "${CHANGES}" | grep -c '^') | ||
|
|
||
| if [ ${{ github.event.inputs.release_candidate }} == 'true' ]; then | ||
| git tag "${NEW_TAG}" "${NEW_TAG}"^{} -f -m "$(printf "This is a ${{ github.event.inputs.part }} release candidate from ${OLD_TAG} → ${NEW_TAG}.\n\nChanges:\n${CHANGES_NEWLINE}")" | ||
| else | ||
| git tag "${NEW_TAG}" "${NEW_TAG}"^{} -f -m "$(printf "This is a ${{ github.event.inputs.part }} release from ${OLD_TAG} → ${NEW_TAG}.\n\nChanges:\n${CHANGES_NEWLINE}")" | ||
| fi | ||
|
|
||
| git tag -n99 --list "${NEW_TAG}" | ||
|
|
||
| - name: Show annotated Git tag | ||
| shell: bash | ||
| run: | | ||
| git show v${{ github.event.inputs.new_version }} | ||
|
|
||
| - name: Push new tag back to GitHub | ||
| shell: bash | ||
| run: | | ||
| if [ ${{ github.event.inputs.dry_run }} == 'true' ]; then | ||
| echo "# DRY RUN" | ||
| else | ||
| git push origin master --tags | ||
| fi | ||
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.
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 is the workflow
pyhfuses to bump the version in CI so that we don't accidentally ever commit something wrong.