A GitHub Action that makes sure checklists are complete an issue is closed
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
docs
tests
.gitignore
CONTRIBUTING.md
Dockerfile
LICENSE
README.md
app.js
dev.example
entrypoint.sh
helpers.js
jest.config.js
package-lock.json
package.json

README.md

Checklist Checker - GitHub Action

A GitHub Action that makes sure checklists are completed before closing issues 📝.

How It Works

This GitHub Action runs when an issues event webhook is fired in your GitHub repo. The action checks if there are incomplete checklist items - [ ] to do in markdown in the issue's description. If there is 1 or > incomplete checklist items, the action labels the issue with "Incomplete Items". Also, if the issue is closed with incomplete checklist items, the action will reopen the issue and comment on the issue.

Examples

Example of issue with incomplete checklist items in the description labeled with "Incomplete Tasks" label: GitHub Logo

Example of re-opened issue with incomplete checklist items in the description labeled with "Incomplete Tasks" label: GitHub Logo

Installation

To use this GitHub Action, you must have access to GitHub Actions. GitHub Actions are currently only available in private beta (you must apply for access) and only work in private repos.

To setup this action:

  1. Create a .github/main.workflow in your GitHub repo.
  2. Add the following code to the main.workflow file and commit it to the repo's master branch.
workflow "Issue Checklist Checker" {
  resolves = ["Check Checklist"]
  on = "issues"
}

action "Check Checklist" {
  uses = "adamzolyak/checklist-checker-action@master"
  secrets = ["GITHUB_TOKEN"]
}
  1. Whenever you create, update, close, or reopen an issue, the action will run!

Contributing

If you have suggestions for how this GitHub Action could be improved, or want to report a bug, open an issue! Or pull request! We'd love all and any contributions. For more, check out the Contributing Guide.

License

ISC © 2018 Adam Zolyak adam@tinkurlab.com (www.tinkurlab.com)