• This repository has been archived on 26/Sep/2023
  • Stars
    star
    145
  • Rank 254,144 (Top 6 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created almost 4 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

πŸ“¦ A GitHub Action for marking issues as dependent on another

Dependent Issues

A GitHub Action for marking issues as dependent on another

It works with PRs and issues and supports cross-repository dependencies.

Usage

Create .github/workflows/dependent-issues.yml with the following content:

name: Dependent Issues

on:
  issues:
    types:
      - opened
      - edited
      - closed
      - reopened
  pull_request_target:
    types:
      - opened
      - edited
      - closed
      - reopened
      # Makes sure we always add status check for PRs. Useful only if
      # this action is required to pass before merging. Otherwise, it
      # can be removed.
      - synchronize

  # Schedule a daily check. Useful if you reference cross-repository
  # issues or pull requests. Otherwise, it can be removed.
  schedule:
    - cron: '0 0 * * *'

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: z0al/dependent-issues@v1
        env:
          # (Required) The token to use to make API calls to GitHub.
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          # (Optional) The token to use to make API calls to GitHub for remote repos.
          GITHUB_READ_TOKEN: ${{ secrets.GITHUB_READ_TOKEN }}

        with:
          # (Optional) The label to use to mark dependent issues
          label: dependent

          # (Optional) Enable checking for dependencies in issues.
          # Enable by setting the value to "on". Default "off"
          check_issues: off

          # (Optional) Ignore dependabot PRs.
          # Enable by setting the value to "on". Default "off"
          ignore_dependabot: off

          # (Optional) A comma-separated list of keywords. Default
          # "depends on, blocked by"
          keywords: depends on, blocked by

          # (Optional) A custom comment body. It supports `{{ dependencies }}` token.
          comment: >
            This PR/issue depends on:

            {{ dependencies }}

            By **[Dependent Issues](https://github.com/z0al/dependent-issues)** (πŸ€–). Happy coding!

Here how it can look like in practice:

example

Inputs

  • label (Optional): The label to use to mark dependent issues. Default dependent.
  • check_issues (Optional): Enable checking for dependencies in issues. Enable by setting the value to on. Default off.
  • ignore_dependabot (Optional): Ignore dependabot PRs. Enable by setting the value to on. Default off. Use this if you run the action on pull_request rather than pull_request_target.
  • keywords (Optional): A comma-separated list of keywords. Default depends on, blocked by.
  • comment (Optional): A custom comment body. It supports {{ dependencies }} token.

Environment variables

  • GITHUB_TOKEN (Required): The token to use to make API calls to GitHub.

FAQ

Trouble setting up the action? Check the FAQ.

Credits

Special thanks to Jason Etcovitch for the original bot idea.

License

MIT Β© Ahmed T. Ali

More Repositories

1

commitlint-bot

[NOT MAINTAINED] use https://github.com/apps/semantic-pull-requests
JavaScript
151
star
2

react-native-styled.macro

βš›οΈ A Utility-First Styling Library for React Native
TypeScript
91
star
3

dep

[DEPRECATED] Use https://github.com/z0al/dependent-issues instead
TypeScript
71
star
4

git-todos

A Git based Todos App for Developers ⚑
Go
59
star
5

poimandres-alacritty

Unofficial Poimandres theme for Alacritty
17
star
6

probot-review-me

Decide when a pull request is ready for review based on its statuses
JavaScript
16
star
7

dotfiles

My NixOS ❄ & macOS 🍏 configuration
Nix
11
star
8

oktane

βš›οΈ A light-weight and customizable library for data fetching in React
TypeScript
8
star
9

stash

A tiny state container for JavaScript apps
TypeScript
6
star
10

handy-gi

Generate a .gitignore string that matches your needs magically βœ¨πŸ’―
JavaScript
5
star
11

unread

A package for parsing RSS and Atom feeds
TypeScript
5
star
12

settings-toggle

Effortlessly Toggle Settings in Visual Studio Code
TypeScript
4
star
13

probot-issue-commands

A Probot extension to make it easier to build commands with syntax similar to GitHub issue closing pattern
TypeScript
3
star
14

gfmc

JavaScript pure implementation of GitHub Flavored Markdown (GFM) specification :octocat:
TypeScript
2
star
15

commitlint-visualize

Easier to read https://npm.im/commitlint reports
JavaScript
2
star
16

submitter

A Prettier UI for Submitting GitHub Issues πŸš€
JavaScript
2
star
17

naming-is-hard

1
star
18

minipack

An interactive webpack-based playground for the modern web ツ
TypeScript
1
star
19

ignr

Automagically generate a .gitignore file that fits your needs
JavaScript
1
star
20

handy-gi-cli

The CLI version of https://github.com/z0al/handy-gi
JavaScript
1
star