CDS Github Standard Labels

GitHub action to sync a repo's issue labels with the set defined in RFC 0003 CDS Github Label Standard.

Usage

To use this action, create the following file in your GitHub repo:

.github/workflows/sync-repo-labels.yml

on: [issues, pull_request, workflow_dispatch]
jobs:
  sync-labels:
    runs-on: ubuntu-latest
    name: Sync repository labels
    steps:
      - uses: cds-snc/labels@v1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

⚠️ Whenever an issue is opened, the workflow will execute. This overrides all labels in the repository and may result in loss of data if it's run on a repo that isn't owned by reliability engineering.

You can do this by running the following command from a repo:

mkdir -p .github/workflows && curl https://raw.githubusercontent.com/cds-snc/labels/v1/example.yml --output .github/workflows/sync-repo-labels.yml

Labels

You can find the current labels in ./labels.js. Edit this file to make changes to reliability engineering's suite of labels.

Changing a label name

When you want to change a label's name, it's very important to add the old label name to the list of aliases for that label. This will ensure that the label is renamed rather than being removed then created. Failing to do this will result in loss of data.

1. Copy the value of the name property and add a new entry in that label's aliases array
2. Change the name property of the label to your new value

Changing a label description

Change the description property for the label you wish to update.

Changing a label colour

Add the new colour value to the colors object. Change the color property for the label you wish to update.

Development

Work should be based on the main branch, with changes PRed in.

If your changes are not breaking, merge them into the v1 branch, and they'll be picked up by every repo running v1 automatically.

If your changes ARE breaking, then you should create a v2 branch based on main and update your chosen repo to use the new workflow.