shayfrendt / github-pr-contains-action

Action that checks whether the body or diff in a PR contains a certain word.

Checking PRs for words and other things

Based on the actions template, we'll try to create a new action. This new action will check for the presence of a word in the body or diff in a PR. 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 add this in a file in .github/workflows

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/v0
      with:
        github-token: ${{github.token}}
        bodyDoesNotContain: "Delete this"
        bodyContains: 'Test'
        diffContains: 'Test'
        diffDoesNotContain: 'Test'
        filesChanged: 1
        linesChanged: 1

The bodyContain variable will include the string that we want the body of the PR to include, such as checked items in a checklist.

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

An example is used as .github/workflows/pr.yaml in this repository.

Contributing to development

Any suggestion, but report, etc, is appreciated. Please use issues for doing that.

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.

License

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