Setup Labels¶

Create or update repository label metadata from a label configuration file.

Usage¶

- name: Setup labels
  id: labels
  uses: athackst/ci/actions/setup-labels@main
  with:
    github-token: ${{ github.token }}

Inputs¶

Name	Description	Default
`github-token`	(optional) GitHub token with permissions to manage repository labels.	`${{ github.token }}`
`repo`	(optional) Repository in `owner/repo` format where labels should be managed.	`${{ github.repository }}`
`configuration-path`	(optional) Path to the label configuration file.	Bundled `../pr-labeler/labeler.yml`

Outputs¶

Name	Description
`created-labels`	Comma-separated labels created.
`updated-labels`	Comma-separated labels updated.
`unchanged-labels`	Comma-separated labels already matching the desired metadata.
`skipped-labels`	Comma-separated labels skipped because they did not define usable metadata for label setup.

Permissions¶

Requires a token that can create and update repository labels. issues: write is typically sufficient.

Advanced¶

Uses the bundled PR labeler config when configuration-path is not set.
If a custom config path is missing, the action falls back to the bundled config.
The action validates the config before calling the GitHub API.
Labels with neither description nor color are skipped quietly.
If description is missing, the label is skipped.
If color is missing, the action uses the default color 808080.
Outputs are written before the step fails, so skipped and partial results remain available on error.
Existing labels are matched case-insensitively before deciding whether to create, update, or leave them unchanged.

Examples¶

Use a repository-specific label config:

- name: Setup labels
  uses: athackst/ci/actions/setup-labels@main
  with:
    github-token: ${{ secrets.CI_BOT_TOKEN }}
    configuration-path: .github/ci-config.yml