Skip to content
check-square

GitHub Action

Required Task Completed Checker

v0.2.0 Latest version

Required Task Completed Checker

check-square

Required Task Completed Checker

An action that checks if tasks marked as required have been completed

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Required Task Completed Checker

              
  uses: macqueenism/required-task-checker-action@v0.2.0
Learn more about this action in macqueenism/required-task-checker-action

Choose a version

Task Completed Checker Action

A GitHub action that checks if tasks marked as required are completed on pull requests.

Usage

Create a workflow

name: 'PR Tasks Completed Check'
on:
  pull_request:
    types: [opened, edited]

jobs:
  task-check:
    runs-on: ubuntu-latest
    steps:
      - uses: macqueenism/required-task-checker-action@v0.2.1
        with:
          repo-token: "${{ secrets.GITHUB_TOKEN }}"

Check whether required tasks are completed

In the description of a pull request:

## Issue Type
The following tasks will be ignored
- [ ] Bug
- [ ] Document
- [ ] Enhancement

## Checklist
The following tasks will be required
<!-- required-tasks -->
- [x] I have read the [CONTRIBUTING.md]()
- [x] I have made corresponding changes to the documentation
- [x] My changes generate no lint errors
- [x] I have added tests that prove my fix is effective or that my feature works
- [x] New and existing unit tests pass locally with my changes
<!-- /required-tasks -->

Licence

MIT