GitHub Action
GitHub PR Content Checker with regex
v4.3
Latest version
This action checks for the presence or absence of a word in the body or diff in a PR, as well as the number of lines and files changed. If fails if one or more of the set criteria isn't met.
You need to add this in a file in .github/workflows
and set appropriate options.
name: "Check PR content"
on: [pull_request]
jobs:
check_pr:
runs-on: ubuntu-latest
steps:
- name: Check PR
uses: pablo-statsig/gh-pr-content-checker@master
with:
github-token: ${{github.token}}
bodyContains: 'Add this'
bodyDoesNotContain: "Delete this"
diffContains: 'Add this'
diffDoesNotContain: "Delete this"
diffContainsRegex: '<regex here>'
diffDoesNotContainRegex: '<regex here>'
maxLinesChanged: 1
maxFilesChanged: 1
An example is also provided in .github/workflows/ in this repository.
This is a customisation of jsoares/gh-pr-content-checker, adding regex
v0
: Proof of concept, published to marketplacev1
: Adds several more checksv2
: Adds check for strings to avoid and creates issues for errors.
--forked--
v3
: Adds diffDoesNotContain field, improves counting behaviour, update deps
--forked--
v4
: Adds regex checking
This is a modification of jsoares/gh-pr-content-checker and is released under the MIT license.