https://github.com/gregsdennis/dependencies-action

A GitHub Action that enforces PR dependencies
https://github.com/gregsdennis/dependencies-action

Last synced: 6 days ago
JSON representation

A GitHub Action that enforces PR dependencies

• Host: GitHub
• URL: https://github.com/gregsdennis/dependencies-action
• Owner: gregsdennis
• License: mit
• Created: 2020-11-22T01:47:50.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-09T20:13:23.000Z (3 months ago)
• Last Synced: 2024-10-26T10:50:42.388Z (11 days ago)
• Language: JavaScript
• Size: 8.47 MB
• Stars: 33
• Watchers: 4
• Forks: 10
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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:

- [PR to be landed first](http://github.com/gregsdennis/dependencies-action/pull/4)

- [PR to be landed second](http://github.com/gregsdennis/dependencies-action/pull/5)

## Example usage

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

```yaml

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 }}

```