Skip to content
zap

GitHub Action

link-your-issues

0.1.0 Latest version

link-your-issues

zap

link-your-issues

Test whether contributors properly link issues mentioned in commits in their PR descriptions

Installation

Copy and paste the following snippet into your .yml file.

              

- name: link-your-issues

uses: actions-automation/[email protected]

Learn more about this action in actions-automation/link-your-issues

Choose a version

link-your-issues

A Github Action to test whether contributors properly link issues mentioned in commits in their PR descriptions.

Usage is simple; just include it in a workflow that runs on a pull request event:

name: link-your-issues

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

jobs:
  link-your-issues:
    runs-on: ubuntu-latest
    steps:
    - uses: actions-automation/link-your-issues@main
      with:
        repo-token: ${{ secrets.GITHUB_TOKEN }}

The repo-token input must be a valid Github access token; the GITHUB_TOKEN provisioned by Actions should suffice.

See link-your-issues.yml for an example.