Skip to content

Latest commit

 

History

History
142 lines (105 loc) · 8.06 KB

README.md

File metadata and controls

142 lines (105 loc) · 8.06 KB
Raw

Pull Request Ticket Check Action

Build status

Verify that pull request titles start with a ticket ID

Overview

This Github Action helps ensure that all pull requests have an associated ticket ID in their title.

It can detect the ID in the title of the pull request, in the branch name, whether a reference ID (#123) is in the body, or even if a full URL is in the body.

If no ticket/issue ID is in the title, it will extract the ID from the branch or body and update the title for you. It will fail the check if no ticket ID is found anywhere.

If a ticketLink input is provided and named groups (?<ticketNumber>) are used in regexes, a ticket link will be posted on a PR upon a successful match. This overrides the quiet option.

Usage

In your .github/workflows folder, create a new pull_request_linting.yml file with the respective contents based on your needs.

The examples provided require some customizations unique to your codebase or issue tracking. If you're unfamiliar with building a regex, check out Regexr.

Make sure you check for the following to swap out with your values:

  • :owner / :org - used in all examples
  • :repo - used only in the GitHub example

Examples

GitHub

name: Pull Request Lint

on:
  pull_request:
    types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
  title:
    name: ticket check
    runs-on: ubuntu-latest

    steps:
      - name: Check for ticket
        uses: neofinancial/ticket-check-action@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          ticketLink: 'https://github.com/:owner/:repo/issues/%ticketNumber%'
          ticketPrefix: '#'
          titleRegex: '^#(?<ticketNumber>\d+)'
          branchRegex: '^(?<ticketNumber>\d+)'
          bodyRegex: '#(?<ticketNumber>\d+)'
          bodyURLRegex: 'http(s?):\/\/(github.com)(\/:owner)(\/:repo)(\/issues)\/(?<ticketNumber>\d+)'

Jira

name: Pull Request Lint

on:
  pull_request:
    types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
  title:
    name: ticket check
    runs-on: ubuntu-latest

    steps:
      - name: Check for ticket
        uses: neofinancial/ticket-check-action@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          ticketLink: 'https://:org.atlassian.net/browse/PROJ-%ticketNumber%'
          ticketPrefix: 'PROJ-'
          titleRegex: '^PROJ-(?<ticketNumber>\d+)'
          branchRegex: '^PROJ-(?<ticketNumber>\d+)'
          bodyRegex: 'PROJ-(?<ticketNumber>\d+)'
          bodyURLRegex: 'http(s?):\/\/(:org.atlassian.net)(\/browse)\/(PROJ\-)(?<ticketNumber>\d+)'

Shortcut (formerly Clubhouse)

name: Pull Request Lint

on:
  pull_request:
    types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
  title:
    name: ticket check
    runs-on: ubuntu-latest

    steps:
      - name: Check for ticket
        uses: neofinancial/ticket-check-action@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          ticketLink: 'https://app.shortcut.com/:org/story/%ticketNumber%'
          ticketPrefix: 'SC-'
          titleRegex: '^(CH|sc)(-?)(?<ticketNumber>\d+)'
          branchRegex: '^(CH|sc)(-?)(?<ticketNumber>\d+)'
          bodyRegex: '(CH|sc)(-?)(?<ticketNumber>\d+)'
          bodyURLRegex: 'https?:\/\/app\.(clubhouse.io|shortcut.com)(\/:org)\/story\/(?<ticketNumber>\d+)'

Inputs

Name Required Description default
token ✅ The GitHub access token
ticketLink The URL format for a link to a ticket with a %ticketNumber% placeholder
ticketPrefix The unique identifier for the ticket/issue
titleFormat The intended format the title should be set to if it doesn't match the regular expression. Available variables are %prefix%, %id%, and %title% %prefix%%id%: %title%
titleRegex The regular expression used to search the title for the intended format ^(CH)(-?)(?\d{3,})
titleRegexFlags The regular expression flags applied to the title regular expression gi
branchRegex The regular expression used to search the branch for the intended format ^(CH)(-?)(?\d{3,})
branchRegexFlags The regular expression flags applied to the branch regular expression gi
bodyRegex The regular expression used to search the body for a shorthand reference (example #123) (CH)(-?)(?\d{3,})
bodyRegexFlags The flags applied to the body regular expression when searching for a shorthand reference gim
bodyURLRegex The regular expression used to search the body for a URL reference (example https://github.com/octocat/hello-world/issues/1)
bodyURLRegexFlags The flags applied to the body regular expression when searching for a URL reference gim
exemptUsers Comma separated string of usernames that will be exempt from all checks. Most useful for bot/automated PRs (example "octocat,dependabot")
quiet If true, don't comment when a PR title is updated true

Releasing

Publishing a release

To publish a release use the Release workflow. When you run the workflow it will ask you for a version tag like v2.0.0. This should be the full version number of the new release. It will also ask you for a major version number like v2. This allows you to reference the release as either @v2 of @v2.0.0. You can also reference the hash of the release for additional security.

After the workflow runs a draft release will be created on GitHub. Edit the release and copy the CHANGELOG entries into the description. Then publish the release, including publishing to the GitHub Marketplace.

Creating a preview Release

To create a preview release use the Release Next workflow. When you run the workflow it will ask you for the name of the branch to build. This should be the feature branch that you want to test. The release will be published to the next branch and you can use neofinancial/ticket-check-action@next in your workflows to test the preview release.