A set of GitHub Actions (JavaScript) to trigger an AWS CodePipeline with a specific slash command in the PR comments.
This merge flow disables the possibility to use the merge button in a pull request. The merge is instead decided by scripts.
An information comment is created - describing that manual merging is disabled. The PR is set to a pending state, which will disable the merge button.
When PR is done, a merge request must be issued by typing the slash command /merge-it in the comments fields of the PR.
To be able to merge a PR a series of conditions must first be met before triggering the AWS CodePipeline. The following
conditions must be met:
- PR is in OPEN state
- PR is NOT already MERGED
- PR is NOT out-of-date with the base branch
- PR is NOT in CONFLICTING state (conflicts must first be resolved)
- PR is NOT in FAILURE state (At least one push is required to trigger merge again)
- PR is APPROVED by required reviewers
If a PR must be merged right away, without running tests a special slash command /merge-now can be issued in the comments fields of the PR.
Note: The above conditions must still be met to use the emergency merging command. Should only be used if really needed.
In the settings of the GitHub workflow file a "trigger branch" is defined. This is the name of a branch where an empty commit will be made to.
AWS will listen to push on that particular branch. The commit message will contain a message with the branch name and head SHA of the PR.
Branch: <Branch Name>, PR: <Head SHA of PR>.
If the CodePipeline which runs all tests is successful, it needs to trigger the actual merging of the PR branch into the base branch. This is done
by adding a new state to the latest commit of the PR. Two different states can be reported back: success or failure. This can be done using
the GitHub API. A new success state will trigger a workflow which will merge the PR into the base branch. A new failure state will require at least
one more push to the PR branch before a new merge can be requested.
This is a public repository.
Keep any Aller specific secrets and other sensitive information away from this repository. Also, pass branch names and other data as variables from the workflow definitions rather than hardcoding them in the action source file.
All work should be done in feature branches. Branches should have human readable name, and when needed, some sort of ID
used fe. Jira. (fe. SELAB-001-my-first-branch, or my-first-branch when not used with linked tickets)
This codebase is versioned by tags. These tags are used when defining which version to use in the workflow defintion files in the repository it is used in. To tag a new version:
git commit -m "Version 1.67"
git tag -a -m "Version 1.67" v1.67
git push ... --follow-tagsNote: ... should be replaced with specific branch names etc.
Merging to master should happen through pull requests. Any pull request should have been approved by at least one person before merging.
Because this GitHub action is dependent on hydration of event based payloads and a temporary GITHUB_TOKEN it is not possible to run this action in a localhost environment.
The base branch of the repository where this action is used needs to be a protected branch with a branch protection rule like this:
- Enable require a pull request before merging
- Enable require approvals
- Enable dismiss stale pull request approvals when new commits are pushed
- Enable require status checks to pass before merging (Select/search for a check with name default and select any source)
Place the following .yml files in the .github / workflows folder in the project where the workflows should be used.
on:
pull_request:
types: [opened, reopened]
jobs:
prinit:
runs-on: ubuntu-latest
name: New PR action
steps:
- name: Make an info comment and disable merging
id: init
uses: allermedia/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
WORKFLOW_ACTION: 'prinit'on: issue_comment
jobs:
pr_commented:
# This job only runs for pull request comments
name: Check PR comment for merge-it slash command
if: ${{ github.event.issue.pull_request }}
runs-on: ubuntu-latest
steps:
- name: merge-it
if: ${{ contains(github.event.comment.body, '/merge-it') }}
uses: allermedia/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
WORKFLOW_ACTION: 'merge-it'
TRIGGER_BRANCH: 'live'on: issue_comment
jobs:
pr_commented_now:
# This job only runs for pull request comments
name: Check PR comment for merge-now slash command
if: ${{ github.event.issue.pull_request }}
runs-on: ubuntu-latest
steps:
- name: merge-now
if: ${{ contains(github.event.comment.body, '/merge-now') }}
uses: allermedia/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
WORKFLOW_ACTION: 'merge-now'
BASE_BRANCH: 'master'on:
status
jobs:
if_success:
name: Merge if status changed to success
if: ${{ github.event.state == 'success' }}
runs-on: ubuntu-latest
steps:
- name: merge
uses: allermedia/[email protected]
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
WORKFLOW_ACTION: 'merge-pr'
BASE_BRANCH: 'master'This action is developed by Aller Media and can be deleted or modified at any time without notice.