Skip to content
GitHub Action to declaratively setup labels across repos
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib 2.0.0 release (#8) Aug 26, 2019
screenshots
.gitignore 2.0.0 release (#8) Aug 26, 2019
CHANGELOG.md 2.0.0 release (#8) Aug 26, 2019
LICENSE
README.md Update example YAML in README (#11) Oct 1, 2019
action.yml 2.0.0 release (#8) Aug 26, 2019
index.js 2.0.0 release (#8) Aug 26, 2019
package-lock.json
package.json 2.0.0 release (#8) Aug 26, 2019

README.md

Issue Label Manager Action

This GitHub Action allows you to declaratively state the labels to be defined in a repo.

In the repo you'd like to use this, define a JSON file in .github/labels.json. This file will contain an array of objects that have a name, color, and description as shown in the example below.

labels.json file

Then, set up a workflow that executes this action. When run, it will update the list of labels in the repo to match the JSON file and will delete any other labels.

The result of using the labels.json file shown above is as follows:

Labels result

If a label doesn't need a description, leave out the description field of the entry in the json file and when deployed the label will not contain a description.

Usage

This action only needs the GITHUB_TOKEN secret as it interacts with the GitHub API to modify labels. The action can be used as such:

on: issues
name: Create Default Labels
jobs:
  labels:
    name: DefaultLabelsActions
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@1.0.0
      - uses: lannonbr/issue-label-manager-action@2.0.0
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
You can’t perform that action at this time.