Skip to content

gregsdennis/dependencies-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

PR Dependency Check Action

This GitHub Action enforces PR dependencies as stated in a PR's opening comment.

The bot parses the first comment of a PR looking for the key phrases "depends on" or "blocked by" followed by an issue number specified by # and the issue or PR number (e.g. #5).

Supported link styles

The action can detect links in the following styles:

  • Quick Link: #5
  • Partial Link: gregsdennis/dependencies-action#5
  • Partial URL: gregsdennis/dependencies-action/pull/5
  • Full URL: https://github.com/gregsdennis/dependencies-action/pull/5
  • Markdown: [markdown link](https://github.com/gregsdennis/dependencies-action/pull/5)

Works for both issues and PRs!

Also supports custom domains for use with GitHub Enterprise!

See it in action:

Example usage

Just add the following to a .yml file in your .github/workflows/ folder.

on:
  pull_request_target: 
    types: [opened, edited, closed, reopened]

jobs:
  check_dependencies:
    runs-on: ubuntu-latest
    name: Check Dependencies
    steps:
    - uses: gregsdennis/dependencies-action@main
      with:
        custom-domains: my-custom-domain.io another.domain.com
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}