https://github.com/trstringer/require-label-prefix

GitHub Action to either warn or add a default label when no label with a prefix exists on an issue
https://github.com/trstringer/require-label-prefix

devops devops-tools github github-actions issue-management issues

Last synced: about 1 month ago
JSON representation

GitHub Action to either warn or add a default label when no label with a prefix exists on an issue

• Host: GitHub
• URL: https://github.com/trstringer/require-label-prefix
• Owner: trstringer
• License: other
• Created: 2022-06-27T21:43:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-12T22:55:20.000Z (over 2 years ago)
• Last Synced: 2024-03-14T21:42:10.859Z (10 months ago)
• Topics: devops, devops-tools, github, github-actions, issue-management, issues
• Language: Go
• Homepage:
• Size: 27.3 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Action - Require Label Prefix

[![CI](https://github.com/trstringer/require-label-prefix/actions/workflows/main.yaml/badge.svg)](https://github.com/trstringer/require-label-prefix/actions/workflows/main.yaml)

Use this GitHub action to either warn or add a default label based on prefixes.

## Usage

```yaml

steps:

  - uses: trstringer/require-label-prefix@v1

    with:

      secret: ${{ github.TOKEN }}

      # prefix is set to whatever prefix you are trying to enforce. For

      # instance, if you want to make sure size labels (e.g. "size/S", "size/L")

      # are enforced, the prefix would be "size".

      prefix: size

      # The prefix is divided by the suffix by some separator. This defaults

      # to "/" and is typically this, but it could be anything (e.g. ":").

      # labelSeparator: "/"

      # addLabel, when set to "true", will label the issue with defaultLabel if

      # the issue doesn't have a label with the prefix. If this is set to "false"

      # then a label won't be added, there will just be a comment requesting that

      # somebody adds a label with the labelPrefix.

      # Options: "true", "false" (default).

      # addLabel: false

      # If addLabel is set, defaultLabel is the label that will be added if there

      # is no label with this prefix already on the issue. E.g. "size/needed".

      # defaultLabel: "size/needed"

      # If you want to only comment on or label issues that are part of a milestone

      # then you would set this to "true". Otherwise, all issues are evaluated.

      # Options: "true", "false" (default).

      # onlyMilestone: false

```