Skip to content

Adding release checks for multiple versions #6

Adding release checks for multiple versions

Adding release checks for multiple versions #6

name: Release Branch Check
on:
pull_request:
branches:
- 'release/**'
- 'main'
types: [opened, synchronize, reopened]
jobs:
validate-release-branch:
runs-on: ubuntu-latest
env:
RELEASE_BRANCH_PREFIX: 'release/'
CURRENT_RELEASE: 'v2'
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set PR variables
id: pr
env:
TARGET_BRANCH: ${{ github.base_ref }}
PR_TITLE: ${{ github.event.pull_request.title }}
PR_LABELS: ${{ github.event.pull_request.labels.*.name }}
BASE_SHA: ${{ github.event.pull_request.base.sha }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
run: |
echo "target_branch=$TARGET_BRANCH" >> $GITHUB_OUTPUT
echo "pr_title=$PR_TITLE" >> $GITHUB_OUTPUT
echo "pr_labels=$PR_LABELS" >> $GITHUB_OUTPUT
echo "base_sha=$BASE_SHA" >> $GITHUB_OUTPUT
echo "head_sha=$HEAD_SHA" >> $GITHUB_OUTPUT
- name: Validate release branch
env:
TARGET_BRANCH: ${{ steps.pr.outputs.target_branch }}
PR_TITLE: ${{ steps.pr.outputs.pr_title }}
PR_LABELS: ${{ steps.pr.outputs.pr_labels }}
BASE_SHA: ${{ steps.pr.outputs.base_sha }}
HEAD_SHA: ${{ steps.pr.outputs.head_sha }}
run: |
# First check if it's a release branch
if [[ ! "$TARGET_BRANCH" =~ ^"$RELEASE_BRANCH_PREFIX" ]]; then
# Not a release branch, no need for release validation
exit 0
fi
# Check if PR has release label
if [[ ! "$PR_LABELS" =~ "release" ]]; then
echo "::error::PRs targeting release branches must have the 'release' label"
exit 1
fi
# Extract version from branch name (e.g., v2 from release/v2)
BRANCH_VERSION=$(echo "$TARGET_BRANCH" | sed "s|$RELEASE_BRANCH_PREFIX||")
# Check if trying to merge to an older release branch
if [[ "$BRANCH_VERSION" != "$CURRENT_RELEASE" ]]; then
# Check for special label that allows merging to older releases
if ! [[ "$PR_LABELS" =~ "allow-older-release" ]]; then
echo "::error::Merging to older release branches (release/$BRANCH_VERSION) is not allowed. Current release is $CURRENT_RELEASE."
echo "::error::If this is intentional, add the 'allow-older-release' label to the PR."
exit 1
fi
fi
# Additional validation for release PRs
# Check if PR title follows release format
if ! [[ "$PR_TITLE" =~ ^Release\ \[[0-9]{4}-[0-9]{2}-[0-9]{2}\]$ ]]; then
echo "::error::Release PR title must follow format: 'Release [YYYY-MM-DD]'"
exit 1
fi
# Check if CHANGELOG.md has been updated
if ! git diff --name-only "$BASE_SHA" "$HEAD_SHA" | grep -q "CHANGELOG.md"; then
echo "::error::CHANGELOG.md must be updated for releases"
exit 1
fi