Git Flow Action

The Git Flow Action is a GitHub Action that assists with the Git Flow branching model. It's feature are:

• Comment when a pull request has a head branch name that doesn't have the feature branch or hotfix branch prefix

• Comment when a feature pull request doesn't target a development branch or another feature branch
  Because pull requests for feature branches should never target a main branch.

• Comment when a hotfix pull request doesn't target a development branch or main branch
  Because pull requests for hotfix branches should never target other branches than these.

• Convert pull requests for cascading feature branches to draft automatically
  This prevents them from being merged accidentally into the base feature branch.

Usage

Create a personal access token with the repo permission and store it in a repository or organization level secret called GIT_FLOW_ACTION_PAT. You can then create the following workflow file in your repository.

.github/workflows/check-pr.yml:

name: Check PR

on:
  # WARNING: Make sure to never check out, build or run untrusted code with the 'pull_request_target' event.
  # See: https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#pull_request_target
  pull_request_target:
    types: [opened, edited]

jobs:

  check-branches:
    name: Check base branch and branch name
    runs-on: ubuntu-latest
    steps:
      - uses: semestry/git-flow-action@v1
        env:
          GITHUB_TOKEN:  ${{ secrets.GIT_FLOW_ACTION_PAT }}

Configuration options

You can override configuration options using in the workflow file. For example:

      - uses: semestry/git-flow-action@v1
        env:
          GITHUB_TOKEN:  ${{ secrets.GIT_FLOW_ACTION_PAT }}
        with:
          feature_branch_prefix: 'feat/'

Option	Description
main_branch_pattern	Regex for matching main branches. Default: ^(main|master)$
development_branch_pattern	Regex for matching development branches. Default: ^(dev|develop|development)$
semestry_staging_branch_pattern	Regex for matching development branches. Default: ^(X.Y-staging|X.Y.Z-staging)$
semestry_testing_branch_pattern	Regex for matching development branches. Default: ^(X.Y-test|X.Y.Z-test)$
feature_branch_prefix	Feature branch prefix. Default: feature/
hotfix_branch_prefix	Hotfix branch prefix. Default: hotfix/
fix_branch_prefix	Fix branch prefix. Default fix/
staging_branch_prefix	Staging branch prefix. Default staging/