dependent-issues

KO | EN

gitlite — search

#hacktoberfest #go #machine-learning #rust #macos #java #awesome #cli #awesome-list #pytorch #security #ios #mcp #open-source

dependent-issues

(★ 168)

📦 A GitHub Action for marking issues as dependent on another

File Explorer

Download Latest Version (.zip)

- - auto-merge.yml
  - main.yml
  - tags.yml
- dependabot.yml
- .gitignore
- pre-commit
- index.js
- index.js.map
- licenses.txt
- sourcemap-register.js
- - action.test.ts
  - helpers.test.ts
  - support.test.ts
- action.ts
- check.ts
- context.ts
- helpers.ts
- support.ts
- types.ts
.editorconfig
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.prettierignore
action.yaml
demo.png
FAQ.md
index.js
jest.config.js
LICENSE
package.json
README.md
tsconfig.json
yarn.lock

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

```yaml
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:

By **[Dependent Issues](https://github.com/z0al/dependent-issues)** (🤖). Happy coding!
```

Here how it can look like in practice:

![example](https://raw.githubusercontent.com/z0al/dependent-issues/main/demo.png)

## 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](./FAQ.md).

## Credits

Special thanks to [Jason Etcovitch](https://github.com/JasonEtco) for the original bot idea.

## License

[dependabot-change]: https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/

dependent-issues

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

dependent-issues

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README