Skip to content
play

GitHub Action

PR TaskList Completed Checker

v1.0.0 Latest version

PR TaskList Completed Checker

play

PR TaskList Completed Checker

An action that checks if all the tasks(if any) in the PR body are completed

Installation

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

              

- name: PR TaskList Completed Checker

uses: venkatsarvesh/[email protected]

Learn more about this action in venkatsarvesh/pr-tasks-completed-action

Choose a version

PR TaskList Completed Checker Action

A GitHub action that checks if all tasks are completed in the pull requests.

Usage

Create a workflow

name: 'PR TaskList Completed Checker'
on: 
  pull_request:
    types: [edited, opened, synchronize, reopened]

jobs:
  task-check:
    runs-on: ubuntu-latest
    steps:
      - uses: venkatsarvesh/[email protected]
        with:
          repo-token: "${{ secrets.GITHUB_TOKEN }}"

Check whether tasks are completed

Add a pull request template to your repository (.github/pull_request_template.md).

For example:

## Checklist
- [ ] Completed code review
- [ ] Ran unit tests
- [ ] Completed e2e tests

Create a pull request that contained tasks list to your repository. This will start a workflow automatically to check whether tasks are completed.

Every update on a pull request will start a new workflow automatically to check pending tasks.

All tasks completed: All tasks completed

Some tasks are still pending:

Some tasks are still pending

You can check a list of uncompleted tasks at the Actions page on clicking Details. List of pending tasks

📝 Licence

MIT