Skip to content

Commit

Permalink
Add workflow to enforce gem version bumps
Browse files Browse the repository at this point in the history
This workflow will run when opening a pull request on gem repositories.
It checks if there are changes to the CHANGELOG.md and version.rb/*.gemspec files.
If those files have not been changed the workflow will fail.

Code changes are often merged into gems without the gem version being bumped.
This leads to changes not being released quickly and sometimes piling up.

https://trello.com/c/R1kkdVjt/3560-re-evaluate-effectiveness-of-gem-auto-release-workflow-3
  • Loading branch information
MuriloDalRi committed Jul 1, 2024
1 parent 82180f9 commit be6992f
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .github/workflows/gem-bump-checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Gem Bump Checker

on:
workflow_call:
secrets:
GH_TOKEN:
required: true

jobs:
check-files:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
show-progress: false
token: ${{ secrets.GH_TOKEN }}
- uses: ruby/setup-ruby@v1
with:
rubygems: latest
bundler-cache: true

- name: "Determine HEAD of default branch"
id: fetch_default_branch_head
run: echo "sha=$(git ls-remote origin HEAD | cut -f 1)" >> "$GITHUB_OUTPUT"

- name: "Determine HEAD of current branch"
id: fetch_current_branch_head
run: echo "sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"

- name: Check PR author
id: check_pr_author
run: echo "pr_author=${{ github.event.pull_request.user.login }}" >> "$GITHUB_OUTPUT"

- name: Check for version and changelog updates
if: steps.check_pr_author.outputs.pr_author != 'dependabot[bot]'
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
BASE_REF: ${{ steps.fetch_default_branch_head.outputs.sha }}
HEAD_REF: ${{ steps.fetch_current_branch_head.outputs.sha }}
run: |
MODIFIED_FILES=$(git diff --name-only "$BASE_REF".."$HEAD_REF")
if ! echo "$MODIFIED_FILES" | grep 'version.rb' && \
! echo "$MODIFIED_FILES" | grep '\.gemspec$'; then
echo "Error: Either version.rb or a .gemspec file must be modified with each pull request to bump the gem version."
exit 1
fi
if ! echo "$MODIFIED_FILES" | grep 'CHANGELOG.md'; then
echo "Error: CHANGELOG.md must be updated with each pull request."
exit 1
fi

0 comments on commit be6992f

Please sign in to comment.