Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
git-pull-request

GitHub Action

Check pull request body, diff and files

releases/v8

Check pull request body, diff and files

git-pull-request

Check pull request body, diff and files

Checks that the body or the added code contains or avoids a word, number of files or lines changed

Installation

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

              

- name: Check pull request body, diff and files

uses: JJ/github-pr-contains-action@releases/v8

Learn more about this action in JJ/github-pr-contains-action

Choose a version

Checking PR bodies and diffs for words, and number of files and lines in files changed.

Originally based on the actions TS template, it checks for the presence of a word in the body or diff in a PR, as well as certain conditions on the PR: number of files changed, and number of lines changed.

It uses the GitHub API, so you'll need to provide a token. Don't worry, that's built-in.

Using this action

You would need to put this in a file in the .github/workflows directory

name: "Check PR for word"
on: [pull_request]

jobs:
  check_pr:
    runs-on: ubuntu-latest
    steps:
    - name: Check PR
      uses: JJ/github-pr-contains-action@releases/v7
      with:
        github-token: ${{github.token}}
        bodyDoesNotContain: "Delete|this"
        bodyContains: 'Test'
        diffContains: ';'
        diffDoesNotContain: "TODO|to do"
        filesChanged: 1
        linesChanged: 1

The bodyContains variable will include the string that we want the body of the PR to include, such as checked items in a checklist; obviously bodyDoesNotContain will hold the opposite, what we don't want to see in the PR body. Any of them can have a | separated list of words or expressions. The PR will check it contains any of the words in bodyContains and none of the words in bodyDoesnotContain.

Same patterm for diff(Contains|DoesNotContain). Can be a word or list of words you want in the diff (for instance, you want it to always change code so it contains a statement terminator) or don't want in the diff (for instance, you don't want it to include TODOs because people never ever do them).

These strings are unwittingly converted into regular expressions, so any regular expression will also work; []()+?* are escaped so that things such as [.] work with the literal meaning.

They can be left empty if no check wants to be done.

An example is used as .github/workflows/check-PRs-here.yaml in this repository as well as this one, which is the one I use for testing.

Contributing to development

Any suggestion, bug report, etc, is appreciated. Please use issues.

See also

There are several forks of this action, with additional features:

History

  • v0: proof of concept, published to marketplace
  • v1: Adds several more checks
  • v2: Adds check for strings to avoid and creates issues for errors.
  • v3: Changes packaging, upgrades modules, deletes unneeded files.
  • v4: Solves a number of issues.
  • v5: Will not use diffContains if it's an empty string
  • v6: can use words or regular expressions in bodyContains/ bodyDoesNotContain
  • v7: includes more "rexified" characters: *,?,+
  • v8: adds diffDoesNotContain and extends regex testing to diff tests.

License

This is a modification of the original template, and is released under the MIT license.