Repository files navigation

This action ensures that pull requests cannot be merged until required checklist items in the PR description are explicitly acknowledged with an accepted status value.

The action reads the enforced checklist items fromconfig/checklist-items.txt. When a pull request includes any of those labels in its description, the action verifies that each one is annotated with exactly one of the following status values inside the brackets:

• ✔ — completed, treated as a pass
• ✖ — not complete, treated as a pass - sometimes we legitimately may want to answer in the negative.
• NA orna — not applicable, treated as a pass

Checklist entries that are not present in the PR description also trigger a failure, ensuring authors explicitly acknowledge every required item. The action reports missing items separately from unchecked items and emits GitHub workflow error annotations for each issue so reviewers can see what needs attention at a glance. To customize which items are enforced, editconfig/checklist-items.txt in this repository.

See .github/workflows/matomo-ai-checklist.yml as an example usage (this repo checks its own PR bodies).

Run the bundled self-tests with Node's test runner:

npmtest

The tests temporarily replaceconfig/checklist-items.txt with the single entryTest line and exercise several checklist permutations, covering each supported status value as well as invalid inputs. The original configuration is restored automatically at the end of the test run.