Skip to content

A GitHub action to label issues and PRs when they're blocked by another issue or PR.

License

Notifications You must be signed in to change notification settings

tristan-orourke/blocking-issues

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

97 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Blocking Issues

A GitHub action to label issues and PRs when they're blocked by another issue or PR.

To record blocking issues, create a tasklist with the title "Blocked By".

```[tasklist]
### Blocked By
- [ ] #1111
- [x] #2222
- [ ] #3333
```
  • When triggered by an open PR: Checks for blocking issues in the PR text
  • When triggered by a closed issue: Checks for other PRs that were blocked by this issue and updates them

Add this file to .github/workflows/blocking-issues.yml:

name: Blocking Issues

on: 
  issues:
    types: [opened, edited, deleted, transferred, closed, reopened]
  pull_request_target: 
    types: [opened, edited, closed, reopened]
    
jobs: 
  blocking_issues: 
    runs-on: ubuntu-latest
    name: Checks for blocking issues
    
    steps: 
      - uses: tristan-orourke/blocking-issues@v1.0
        with: 
          # Optional: Choose an existing label to use instead of creating a new one.
          # If the label cannot be found, the default one will be created and used.
          # The default is: "blocked" (black).
          use-label: "blocked: dependencies"

This action will not re-block a PR if the issue is reopened, and will throw an error if the issue cannot be found. Simply edit the PR description to re-run the bot.

About

A GitHub action to label issues and PRs when they're blocked by another issue or PR.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%