Skip to content

Commit 74db5fd

Browse files
Add sync-labels workflow
1 parent 3951d07 commit 74db5fd

File tree

3 files changed

+28
-1
lines changed

3 files changed

+28
-1
lines changed

building/config.json

+6
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,12 @@
673673
"path": "building/tracks/ci/workflows/configlet.md",
674674
"title": "configlet workflow"
675675
},
676+
{
677+
"uuid": "fd512058-4525-4e14-a912-9df870025989",
678+
"slug": "tracks/ci/workflows/sync-labels",
679+
"path": "building/tracks/ci/workflows/sync-labels.md",
680+
"title": "Sync labels workflow"
681+
},
676682
{
677683
"uuid": "191b0fa1-96e2-48a6-ad2e-c34f57443799",
678684
"slug": "tracks/ci/migrating-from-travis",

building/tracks/ci/workflows.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ You should thus not manually change their contents.
2323

2424
### General workflows
2525

26-
- `sync-labels.yml`: automatically syncs the repository's labels from a `labels.yml` file
26+
- [`sync-labels.yml`](/docs/building/tracks/ci/workflows/sync-labels): automatically syncs the repository's labels from a `labels.yml` file
2727

2828
### Track-specific workflows
2929

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Sync labels workflow
2+
3+
The sync labels workflow is defined in the `.github/workflows/sync-labels.yml` file.
4+
The goal of this workflow is to add/update/delete the repository's [GitHub labels](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels).
5+
The labels themselves are defined in the `.github/labels.yml` file.
6+
Whenever the `.github/labels.yml` file changes, the sync labels workflow will automatically update the repository's labels.
7+
8+
## Customizing labels
9+
10+
The labels defined in `.github/labels.yml` come in two forms:
11+
12+
- Shared labels: these are labels used by _all_ Exercism repositories, and they're defined in the [org-wide-files repo](https://github.com/exercism/org-wide-files/blob/main/global-files/.github/labels.yml)
13+
- Track-specific labels: these are defined in an `.appends/.github/labels.yml` file
14+
15+
To add track-specific labels, you'll need to add them to the `.appends/.github/labels.yml` file (see [this example](https://github.com/exercism/python/blob/main/.appends/.github/labels.yml)).
16+
Once you've merged the changes to `main`, a pull request will automatically be opened to change the `.github/labels.yml` file.
17+
After merging that PR, the labels will be automatically updated (see description above).
18+
19+
```exercism/caution
20+
Never manually edit the `.github/labels.yml` file, as those changes will be overwritten the next time labels are synced.
21+
```

0 commit comments

Comments
 (0)