Skip to content
Use this GitHub Action with your project

Add this Action to an existing workflow or create a new one.

View on Marketplace
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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/worksflows/main.yml in your GitHub repo (more info).
  2. Add the following code to the main.yml file and commit it to the repo's master branch.
name: Issue Checklist Checker

on: issues

jobs:
  checkIssue:
    name: Check Issue for Incomplete Checklist
    runs-on: ubuntu-latest
    steps:
      - uses: adamzolyak/checklist-checker-action@master
        env:
          GITHUB_TOKEN: ${{ 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 © 2019 Adam Zolyak adam@tinkurlab.com (www.tinkurlab.com)

About

A GitHub Action that makes sure checklists are complete an issue is closed

Resources

License

Packages

No packages published