Skip to content
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

Version check : Add new GitHub Action to check target PR branches #5988

Merged
merged 1 commit into from
Aug 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions .github/workflows/versionCheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
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 versions["gafferMilestoneVersion"] + "." + 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(
sourceVersion, 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
Loading