freckle / commenter-action

Action to comment on PRs with changed-paths-specific content

Pull Request Commenter

Usage

Create .github/commenter.yml

Backend:
  where:
    path:
      matches: "backend/**/*"
  body: |
    :wave: You've changed Backend code, please:

    - [ ] Do this
    - [ ] And this
    - [ ] And that

Frontend:
  where:
    path:
      matches: "frontend/**/*"
  body: |
    :wave: You've changed Frontend code, please:

    - [ ] Do this
    - [ ] And this
    - [ ] And that

The keys are ignored, and for your own organizational use. We will find the first stanza where the PR's changed files matches any of the given paths and add a comment with the given body.

Create a Workflow

name: Checklists

on:
  pull_request:
    types: [opened]

jobs:
  comment:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/commenter@v1
      with:
        repo-token: "${{ secrets.GITHUB_TOKEN }}"

Inputs

See action.yml.

Additional Options

You can also match based on specific file changes by supplying the additions_or_deletions where-clause configuration key.

For example, if you wanted to comment on any changes that contain the word "unsafe" you could supply a YAML configuration like the following

UnsafeMentionedInCode:
  where:
    path:
      matches: "backend/**/*.hs"
    additions_or_deletions:
      contain:
        - unsafe
  body: |
    :wave: Hi, I see a mention of "unsafe" in Haskell code. If you removed it,
    good going! If you added it, please consider finding a safer alternative!

Acknowledgements

This action was highly inspired by (and began as a copy of) @actions/labeler.

---

LICENSE | CHANGELOG