-
-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3951d07
commit 74db5fd
Showing
3 changed files
with
28 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Sync labels workflow | ||
|
||
The sync labels workflow is defined in the `.github/workflows/sync-labels.yml` file. | ||
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). | ||
The labels themselves are defined in the `.github/labels.yml` file. | ||
Whenever the `.github/labels.yml` file changes, the sync labels workflow will automatically update the repository's labels. | ||
|
||
## Customizing labels | ||
|
||
The labels defined in `.github/labels.yml` come in two forms: | ||
|
||
- 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) | ||
- Track-specific labels: these are defined in an `.appends/.github/labels.yml` file | ||
|
||
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)). | ||
Once you've merged the changes to `main`, a pull request will automatically be opened to change the `.github/labels.yml` file. | ||
After merging that PR, the labels will be automatically updated (see description above). | ||
|
||
```exercism/caution | ||
Never manually edit the `.github/labels.yml` file, as those changes will be overwritten the next time labels are synced. | ||
``` |