Get results of a checklist from the body of a pull request

Sometimes, the body of a pull request contains

- [X] ONE: Checks this.
- [x] Check that.
- [ ] Does not check this.

This will be exported to github action variables, and also set as step output. The outputs will have the name of the label if it exists (ONE, in this case) or checks+ index (starting with 0) otherwise.

The check# variable will not be set in the case it has a specific name.

This one, for instance, will create the variables ONE, checks1 and checks2; the first two of them will be set to true, the last one to false.

You can use any list format

* [X] Submit to the CoC
- [x] CONTRIBUTING: Read the contribution agreement
+ [ ] Agree on license

Use

Check the used workflow for an example; or this:

name: Obtain values for checklist
on: [pull_request]

jobs:
  get-checks:
    runs-on: ubuntu-latest
    steps:
      - name: Verifies checklist in PR body
        id: pr_body_checks
        uses: JJ/pull-request-checks-action@v4.1
      - name: Shows result
        run: echo $CONTRIBUTING && echo $check0

This would act on this pull request template:

- [ ] This PR refers to issue <!-- insert #issue here -->
- [ ] CONTRIBUTING: I have checked out the [guide for contributors](CONTRIBUTING.md).

and create an output and environment variable check0 for the first item, another CONTRIBUTING for the second item. The action just prints the values of the environment variables, you can also use it to fail the flow like this:

      - name: Fails if not checked
        if: ${{ steps.pr_body_checks.outputs.CONTRIBUTING == false}}
        run: echo "Please read CONTRIBUTING.md" && exit 1

History

• release/v1: first real release.
• v1: starting to work again.
• v2: uses labels for checks, works.
• v3: branding and documentation improvements, releasing for real.
• v4: use any list format.
• v4.1: ⬆️ to latest runner and workflow versions

Aclnowledgements

Thanks to Marcos Martín for his contribution to v4 release.