This action reviews whether the Github Pull Request adheres to our ISAE requirements:
- Contains ticket reference in PR title
- Contains ticket reference in branch name
If at least one is missing, it will automatically request changes on the pull request.
If none are missing and there are any changes requested by github actions bot, they will automatically be dismissed.
You need to enable actions on the github project and create the appropriate workflow file. Recommended .github/workflows/isae-pr-review.yml file:
name: Pull request linter
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the main branch
on:
pull_request:
types:
- opened
- edited
- reopened
- synchronize
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "lint"
lint:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- name: Pull Request Linter
# There are two tag styles available: Specific semver version or major version only.
# Recommended is the major version only, since that automatically updates when new versions for that major is released.
# Alternatively instead of a tag, you can use a branch name.
uses: Mobiliteitsfabriek/isae-pull-request@v2
# uses: Mobiliteitsfabriek/isae-pull-request@v1.2.0
# uses: Mobiliteitsfabriek/isae-pull-request@main
with:
# Github token with access to the repository (secrets.GITHUB_TOKEN). Always required
repo-token: ${{ secrets.GITHUB_TOKEN }}
# Enable validation that ticket in title must match ticket in branch.
title-must-match-branch: "true"
# Enable validation that tickets found must exist in JIRA.
validate-with-jira: "true"
# Enable validation that tickets found in JIRA must not have status category "done". Requires validate-with-jira.
validate-jira-status-not-done: "true"
# Base URL of the JIRA environment. Required if validate-with-jira is enabled.
jira-url: mobiliteitsfabriek.atlassian.net
# Authentication email address. Required if validate-with-jira is enabled.
jira-auth-email: ian.zunderdorp@mobiliteitsfabriek.nl
# Authentication API token of above email address. Required if validate-with-jira is enabled. Use secret!
jira-auth-token: ${{ secrets.JIRA_AUTH_TOKEN_IANZ }}
# Ignore pull requests from automated sources
skip-users: |
dependabot
dependabot-preview
# Validation regexp for PR title
pull-request-title-regex: "^\\[?((io|nx)-\\d+)]?"
# Validation regexp for branch name in PR
pull-request-branch-regex: "^[^\\/]+\\/((io|nx)-\\d+)-"
Run bin/build to build the changes into the dist folder. This folder is committed to the repository and read by
Github when running this action.
Create a pull request to main branch with the appropriate semver label added: major, minor or patch.
When the pull request is merged, it will automatically create a new release with both a semver version
plus create or update an appropriate major tag to point to the latest version of that major