Skip to content

Commit

Permalink
Version check : Add new GitHub Action to check target PR branches
Browse files Browse the repository at this point in the history
To avoid the common problem of accidentally targeting `main` instead of one of the maintenance branches.
  • Loading branch information
johnhaddon committed Aug 5, 2024
1 parent e9b70c9 commit 8e3f782
Showing 1 changed file with 77 additions and 0 deletions.
77 changes: 77 additions & 0 deletions .github/workflows/versionCheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: Version check
on: [ pull_request ]
jobs:

check:

name: Version check
runs-on: ubuntu-20.04

steps:

# Checkout both the merge commit for the PR and the
# source branch for the PR.

- uses: actions/checkout@v4
with:
path: merge

- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
path: source

# Do the check.

- name: Check version
run: |
import os
import re
import sys
# Parses version number from the SConstruct file.
def version( filename ) :
versions = {}
versionRe = re.compile( r"^(gaffer.*Version.*) = (\S+)" )
with open( filename ) as sconstruct :
for line in sconstruct.readlines() :
versionMatch = versionRe.match( line )
if versionMatch :
versions[versionMatch.group( 1 )] = versionMatch.group( 2 ).strip( "'\"" )
return [
int( versions["gafferMilestoneVersion"] ),
int( versions["gafferMajorVersion"] ),
]
# Check that versions match between source and target branches, to avoid
# common mistake of targeting a PR to `main` rather than a maintenance branch.
#
# > Note : We compare the source version to the merged version rather than the
# > version from the target branch itself, to allow a PR to change version number
# > if necessary. That will just be subject to the usual human review process.
mergeVersion = version( "merge/SConstruct" )
sourceVersion = version( "source/SConstruct" )
if sourceVersion != mergeVersion :
message = "Source version {} does not match target version {}. Did you choose the wrong target branch?\n".format(
".".join( str( v ) for v in sourceVersion ),
".".join( str( v ) for v in mergeVersion )
)
sys.stderr.write( f"FAIL : {message}" )
with open( os.environ["GITHUB_STEP_SUMMARY"], "a" ) as summary :
summary.write( f"> [!CAUTION]\n> {message}" )
sys.exit( 1 )
else :
with open( os.environ["GITHUB_STEP_SUMMARY"], "a" ) as summary :
summary.write( f"> [!NOTE]\n> Targeting version {mergeVersion}" )
shell: python

0 comments on commit 8e3f782

Please sign in to comment.