Issue Labels
We have specific GitHub repos (known as synced repos throughout this guide) configured to mirror all labels from the root hyphacoop/organizing
,
on each change to the root repo's labels.
Though some of the below steps are more complicated than we'd ideally like,
this is because the automation is cautious and won't delete any in-use labels (regardless of open/closed state),
so nothing destructive will happen.
To manage the list of synced repos (e.g., ensuring a new repo starts having labels synced),
add a new entry to LABEL_REPO_TARGETS
in this configuration file and ensure @hyphacoop-bot has write-access to each synced repo.
To create a new label, just add it to the hyphacoop/organizing
repo,
and it will be added to others within a few minutes.
(Sync events are logged in this issue as new comments for troubleshooting.)
To delete an existing label, search for the label you'd like to delete,
like so.
Our automation is cautious, and so will only delete labels from repos where it's NOT in use.
For any repos represented in the search results, delete the label from that repo.
Once no labelled issues show up, delete the label from hyphacoop/organizing
,
and anything else will be cleaned up. If you leave any issues labelled,
the automation will simply do cleanup on its next run.
As soon as a label is unused in a repo, the automation will remove it on the next run.
To rename an existing label (this one's a bit tricky),
search for the label you'd like to rename,
like so.
Ignore hyphacoop/organizing
for now, we'll save it for last.
For every other repo where it's used, click the "repo" link,
and visit the label page to manually rename.
Lastly, rename the label in hyphacoop/organizing
,
and it will ensure the label is removed in any repos where it wasn't in-use.
(Renaming is understood by the automation as a newly created label and a deleted label.)
To force a label sync, assuming you're impatient for it to do clean-up of unsued labels,
slightly change a description or color of a label in hyphacoop/organizing
.