https://github.com/jop-software/github-labels-as-code-action

Store your issue labels as code in your repository.
https://github.com/jop-software/github-labels-as-code-action

actions github-action github-labels project-management

Last synced: about 8 hours ago
JSON representation

Store your issue labels as code in your repository.

• Host: GitHub
• URL: https://github.com/jop-software/github-labels-as-code-action
• Owner: jop-software
• Created: 2023-01-28T17:07:37.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-03T19:28:41.000Z (almost 2 years ago)
• Last Synced: 2024-04-23T15:23:22.945Z (7 months ago)
• Topics: actions, github-action, github-labels, project-management
• Language: TypeScript
• Homepage:
• Size: 331 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    
GitHub labels as code Action

    
Store your issue labels as code in your repository.



## Inputs

| Name    | Description                                | Default                 |

|---------|--------------------------------------------|-------------------------|

| `token` | Token to use to authorize label changes. (See [_Github Tokens_](#github-tokens))   | `${{ github.token }}`   |

| `file`  | Path to the file you store your labels in. | `./.github/labels.json` |

## Example usage

```yaml

uses: jop-software/[email protected]

with:

  token: "${{ github.token }}"

  file: "./.github/labels.json"

```

**Note:** You need to execute this action *after* [actions/checkout](https://github.com/actions/checkout)

If you want to see a real example of this action, take a look at [the workflows from this repository](./.github/workflows/labels.yaml) 😉 

### Github Tokens

On Feb. 2, 2023 GitHub announced in [a blog post](https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/) that new generated GHA Tokens in repository will be **read only by defaut**.  

Therefore, when you add the action to a repository created after _2023-02-02_ you need to make sure to provide a GitHub token that has **write access** to update issue labels. This can be toggled in the [repository settings](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-default-github_token-permissions).  

When you are using inheritence for repository permissions, please read the [GitHub Blog Post](https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/) explaining that change.

## JSON Format

The expected JSON format follows the _Body parameters_ from the 

[Create a label](https://docs.github.com/de/rest/issues/labels?apiVersion=2022-11-28#create-a-label) GitHub Rest API endpoint.

See the following example:

```json5

[

  {

    "name": "Bug",                            // <- String

    "description": "Something isn't working", // <- String (max 100 chars, optional)

    "color": "d73a4a"                         // <- String (hexadecimal color code without the leading #) 

  }

  // ...

]

```

## Professional Support 

Professional support is available, contact [[email protected]](mailto:[email protected]) for more information.



    © 2023, jop-software Inh. Johannes Przymusinski