Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/redhat-plumbers-in-action/advanced-issue-labeler

🔖 Label issues based on input and defined policy
https://github.com/redhat-plumbers-in-action/advanced-issue-labeler

github-action issue-forms labels policy-based-labeling typescript

Last synced: about 1 month ago
JSON representation

🔖 Label issues based on input and defined policy

Awesome Lists containing this project

README 

        




  

  
Advanced Issue Labeler



[![GitHub Marketplace][market-status]][market] [![Lint Code Base][linter-status]][linter] [![Unit Tests][test-status]][test] [![CodeQL][codeql-status]][codeql] [![Check dist/][check-dist-status]][check-dist]



[![Demo][demo-status]][demo] [![codecov][codecov-status]][codecov]



[market]: https://github.com/marketplace/actions/advanced-issue-labeler

[market-status]: https://img.shields.io/badge/Marketplace-Advanced%20Issue%20Labeler-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=



[linter]: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler/actions/workflows/lint.yml

[linter-status]: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler/actions/workflows/lint.yml/badge.svg



[test]: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler/actions/workflows/unit-tests.yml

[test-status]: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler/actions/workflows/unit-tests.yml/badge.svg



[codeql]: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler/actions/workflows/codeql-analysis.yml

[codeql-status]: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler/actions/workflows/codeql-analysis.yml/badge.svg



[check-dist]: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler/actions/workflows/check-dist.yml

[check-dist-status]: https://github.com/redhat-plumbers-in-action/advanced-issue-labeler/actions/workflows/check-dist.yml/badge.svg



[demo]: https://github.com/redhat-plumbers-in-action/issue-forms-automation/issues/new/choose

[demo-status]: https://img.shields.io/badge/Demo-Issue%20Forms%20Automation-blue



[codecov]: https://codecov.io/gh/redhat-plumbers-in-action/advanced-issue-labeler

[codecov-status]: https://codecov.io/gh/redhat-plumbers-in-action/advanced-issue-labeler/branch/main/graph/badge.svg



Advanced Issue Labeler is a GitHub Action that can automatically label issues based on user input. The idea for this project came from and was first introduced in [@systemd/systemd](https://github.com/systemd/systemd). Systemd repository has a very active community with many issues to process. Automatic labeling helps with issue triaging.



## How does it work



Advanced Issue Labeler takes advantage of GitHub [issue forms](https://github.blog/changelog/2021-06-23-issues-forms-beta-for-public-repositories) (special kind of issue templates) to provide a better developer experience by labeling issues based on provided input. This action works best with [`dropdowns`](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#dropdown) and [`checkboxes`](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#checkboxes).



Advanced Issue Labeler is expected to work in cooperation with [@stefanbuck/github-issue-parser `>= v3.1.1`](https://github.com/stefanbuck/github-issue-parser) GitHub Action. Parser action provides JSON representation of the submitted issue, where KEYs represent IDs described in the issue-form YAML configuration. Issue labeler understands it and can label issues based on selected values from dropdown. Dropdown values could directly represent labels or be mapped to policy configuration for more complex labeling requirements.



## Features



* Ability to label issues based on issue form `dropdowns` and `checkboxes`

* Ability to specify [policy](#policy) for mapping specific keywords to labels

* Ability to exclude certain words from the labeling process ([`block-list`](#block-list))

* Ability to define multiple policies for different issue forms



## Usage



### 1. Simple usecase



The following example shows how to automatically label issues based on the severity that the user describes in issue form. In issue form, there is a defined dropdown listing all severity levels:



```yml

# ...



- type: dropdown

  id: severity

  attributes:

    label: Severity impact

    description: Please choose the severity of the impact of this issue.

    multiple: false

    options:

      - 'None'

      - 'Low'

      - 'Medium'

      - 'High'

      - 'Urgent'

      - 'Other'

  validations:

    required: true



# ...

```



> [!IMPORTANT]

>

> It's essential to set the correct ID in issue-form



GitHub workflow that automatically marks issues with severity labels:



```yml

name: Issue labeler

on:

  issues:

    types: [ opened ]



permissions:

  contents: read



jobs:

  label-component:

    runs-on: ubuntu-latest



    permissions:

      # required for all workflows

      issues: write



      # only required for workflows in private repositories

      actions: read

      contents: read



    steps:

      - uses: actions/checkout@v3



      - name: Parse issue form

        uses: stefanbuck/github-issue-parser@v3

        id: issue-parser

        with:

          template-path: .github/ISSUE_TEMPLATE/bug.yml



      - name: Set labels based on severity field

        uses: redhat-plumbers-in-action/advanced-issue-labeler@v2

        with:

          issue-form: ${{ steps.issue-parser.outputs.jsonString }}

          section: severity

          block-list: |

            None

            Other

          token: ${{ secrets.GITHUB_TOKEN }}

```



### 2. More complex usecase



The following example shows how to automatically label issues based on animal types. In issue form, there is a defined dropdown listing all animals:



```yml

# ...



- type: dropdown

  id: animals

  attributes:

    label: Animals

    description: Please pick all animals you like.

    multiple: true

    options:

      - 'None'

      - '🦍 Gorilla'

      - '🐶 Dog'

      - '🐺 Wolf'

      - '🦊 Fox'

      - '🐴 Horse'

      - '🐓 Rooster'

      - '🐦 Bird'

      - '🐧 Penguin'

      - '🐸 Frog'

      - '🐬 Dolphin'

      - '🐡 Blowfish'

      - '🐟 Fish'

      - '🦈 Shark'

      - '🐛 Bug'

      - '🕷️ Spider'

      - '🐊 Crocodile'

      - 'Other'

  validations:

    required: true



# ...

```



> [!IMPORTANT]

>

> It's essential to set the correct ID in issue-form



Let's define a policy that will allow us to map animals to their types. Policy needs to be stored in `.github/advanced-issue-labeler.yml`.



```yml

policy:

  - section:

      - id: [animals]

        block-list: ['None', 'Other']

        label:

          - name: 'kind: amphibians'

            keys: ['🐸 Frog']

          - name: 'kind: birds'

            keys: ['🐓 Rooster', '🐦 Bird', '🐧 Penguin']

          - name: 'kind: fish'

            keys: ['🐡 Blowfish', '🐟 Fish', '🦈 Shark']

          - name: 'kind: mammals'

            keys: ['🦍 Gorilla', '🐶 Dog', '🐬 Dolphin', '🐺 Wolf', '🦊 Fox', '🐴 Horse']

          - name: 'kind: reptiles'

            keys: ['🐊 Crocodile']

          - name: 'invertebrates'

            keys: ['🐛 Bug', '🕷️ Spider']

```



GitHub workflow that automatically marks issues with animal types labels:



```yml

name: Issue labeler

on:

  issues:

    types: [ opened ]



permissions:

  contents: read



jobs:

  label-component:

    runs-on: ubuntu-latest



    permissions:

      # required for all workflows

      issues: write



      # only required for workflows in private repositories

      actions: read

      contents: read



    steps:

      - uses: actions/checkout@v3



      - name: Parse issue form

        uses: stefanbuck/github-issue-parser@v3

        id: issue-parser

        with:

          template-path: .github/ISSUE_TEMPLATE/bug.yml



      - name: Set labels based on animals field

        uses: redhat-plumbers-in-action/advanced-issue-labeler@v2

        with:

          issue-form: ${{ steps.issue-parser.outputs.jsonString }}

          token: ${{ secrets.GITHUB_TOKEN }}

```



### Real-life examples



* [`Lightning-AI/pytorch-lightning`](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/Lightning-AI/pytorch-lightning%24+file:%5E%5C.github/workflows+redhat-plumbers-in-action/advanced-issue-labeler&patternType=literal) [![GitHub Repo stars](https://img.shields.io/github/stars/Lightning-AI/pytorch-lightning?style=social)](https://github.com/Lightning-AI/pytorch-lightning)



* [`bazelbuild/bazel`](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/bazelbuild/bazel%24+file:%5E%5C.github/workflows+redhat-plumbers-in-action/advanced-issue-labeler&patternType=literal) [![GitHub Repo stars](https://img.shields.io/github/stars/bazelbuild/bazel?style=social)](https://github.com/bazelbuild/bazel)



* [`realm/realm-swift`](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/realm/realm-swift%24+file:%5E%5C.github/workflows+redhat-plumbers-in-action/advanced-issue-labeler&patternType=literal) [![GitHub Repo stars](https://img.shields.io/github/stars/realm/realm-swift?style=social)](https://github.com/realm/realm-swift)



* [`systemd/systemd`](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/systemd/systemd%24+file:%5E%5C.github/workflows+redhat-plumbers-in-action/advanced-issue-labeler&patternType=literal) [![GitHub Repo stars](https://img.shields.io/github/stars/systemd/systemd?style=social)](https://github.com/systemd/systemd)



* [`realm/realm-java`](https://sourcegraph.com/search?q=context:global+repo:%5Egithub%5C.com/realm/realm-java%24+file:%5E%5C.github/workflows+redhat-plumbers-in-action/advanced-issue-labeler&patternType=literal) [![GitHub Repo stars](https://img.shields.io/github/stars/realm/realm-java?style=social)](https://github.com/realm/realm-java)



* more examples - [here](https://github.com/redhat-plumbers-in-action/advanced-issue-labeler/network/dependents)



Feel free to try `advanced-issue-labeler` in template repository - [`@redhat-plumbers-in-action/issue-forms-automation`](https://github.com/redhat-plumbers-in-action/issue-forms-automation)



## Configuration options



Action currently accepts the following options:



```yml

# ...



- uses: redhat-plumbers-in-action/advanced-issue-labeler@v2

  with:

    issue-form:   

    template:     

    section:      

    block-list:   

    config-path:  

    token:        



# ...

```



### issue-form



Issue-form parsed into `JSON` file. Supported format is generated using [@stefanbuck/github-issue-parser](https://github.com/stefanbuck/github-issue-parser) GitHub action.



* default value: `undefined`

* requirements: `required`



### template



Each issue form can have a defined different labeling policy, and this option is used to specify which policy should be used.



* default value: `undefined`

* requirements: `optional`



### section



The ID of the section (`dropdown` or `checkboxes` section is recomended) from the issue form template.



* default value: `undefined`

* requirements: `required`



### block-list



List of forbidden labels. These labels won't be set.



* default value: `undefined`

* requirements: `optional`



> [!TIP]

>

> _Please notice the `|` in the example above ☝️. That lets you effectively declare a multi-line YAML string. You can learn more about multi-line YAML syntax [here](https://yaml-multiline.info). This syntax is required when block-listing multiple labels._



### config-path



Path to configuration file. Configuration file format is described in: [Policy section](#policy).



* default value: `.github/advanced-issue-labeler.yml`

* requirements: `optional`



### token



Token used to set labels



* default value: `undefined`

* requirements: `required`

* recomended value: `secrets.GITHUB_TOKEN`



## Outputs



### labels



List of labels that were set based on the provided policy. The output is a stringified JSON array.



> [!TIP]

>

> Use [`fromJSON`](https://docs.github.com/en/actions/learn-github-actions/expressions#fromjson) function to parse the output to get an array of labels.

>

> ```yml

> element: ${{ fromJSON(steps..outputs.labels)[0] }}

> ```



### policy



The representation of the policy that was used to set labels. The output is a stringified JSON object.



Example output in JSON format where:



* `template` - the name of the template that was used to parse the issue form

* `section` - key-value pairs where the key is the ID of the issue-form section and the value is an array of the applied labels for the given section



```json

{

  "template": "bug.yml",

  "section": {

    "severity": [ "low" ],

    "priority": [ "high" ]

  }

}

```



> [!TIP]

>

> Use [`fromJSON`](https://docs.github.com/en/actions/learn-github-actions/expressions#fromjson) function to parse the output to get an object of policy.

>

> ```yml

> severity: ${{ fromJSON(steps..outputs.policy).section.severity }}

> ```



## Policy



It's possible to define a labeling policy to further customize the labeling process. The policy can be defined using `.github/advanced-issue-labeler.yml` configuration file. The structure needs to be as follows:



```yml

policy:

  - template: ['bug.yml', 'feature.yml']

    section:

      - id: ['severity', 'priority']

        block-list: []

        label:

          - name: 'Low'

            keys: ['Low', 'None']

          - name: 'Medium'

            keys: ['Medium']

          - name: 'High'

            keys: ['High']

          - name: 'Urgent'

            keys: ['Urgent']

      - id: [animals]

        block-list: ['None', 'Other']

        label:

          - name: 'amphibians'

            keys: ['🐸 Frog']

          - name: 'birds'

            keys: ['🐓 Rooster', '🐦 Bird', '🐧 Penguin']

          - name: 'fish'

            keys: ['🐡 Blowfish', '🐟 Fish', '🦈 Shark']

          - name: 'mammals'

            keys: ['🦍 Gorilla', '🐶 Dog', '🐬 Dolphin', '🐺 Wolf', '🦊 Fox', '🐴 Horse']

          - name: 'reptiles'

            keys: ['🐊 Crocodile']

          - name: 'invertebrates'

            keys: ['🐛 Bug', '🕷️ Spider']

# - template: ...

```



### `template` keyword



Array of issue-forms (e.g. `['bug-report.yml']`). This section is used to determine the correct labeling policy when multiple policies are defined. Works in cooperation with [template option](#template).



* requirements: `optional`



### `section.id` keyword



Equivalent of [section](#section) option. An array of IDs of section from issue-form. These IDs need to point to section in the issue-form template.



* requirements: `required`



### `section.block-list` keyword



Equivalent of [block-list](#block-list) option. An array of forbidden keywords. These keywords will be excluded when applying labeling policy.



* requirements: `required`



### `section.label` keyword



Section of policy describing labeling policy. `label` section of the policy is expected to have the following properties:



* `name` - Name of label

* `keys` - Array of keywords corresponding to values from `issue-form` section



* requirements: `required`



## Limitations



* Currently it's not possible to use strings containing `,␣` in the dropdown menu or checkboxes value. This pattern is used in the separation process (e.g. when the dropdown option `multiple` is set to `true`).