Make minimum set of labels available across repos #145

patcon · 2019-11-14T21:29:40Z

Re-ticketed from #132

Shared Description

🗣️ Loomio: N/A
📅 Due date: N/A
🎯 Success criteria: We have an appropriate set of labels available in each repo we want them in.

I've run up against labels being missing from repos that are only in hyphacoop/organizing. @dcwalk and I have worked on a project (EDGI) with multiple repos, where keeping them in sync was nice. (see here)

Proposed labels: See comment below.

Proposed repos: All repos. why not! (to keep it simple, even if some will be almost guaranteed unused)

🔍 ~~@dcwalk and @patcon have used this: https://github.com/edgi-govdata-archiving/overview/pull/230/files?short_path=b8330c6#diff-b8330c648c0fc5041055a6ff8a040c92~~
🔍 GitHub orgs can have default labels.
- 🔍 These defaults are useful for new repos, but less so for existing ones and ongoing synchronization.
💡 Let's decide the labels we want.
💡 Let's sync labels ~~like EDGI did.~~
💡 Let's sync labels from one repo to rest using github-sync tool and github actions (see Make minimum set of labels available across repos #145 (comment) below).

cc: @hyphacoop/infra-ops-wg

To Do

create new low-access team for robots
- give team write permission for all required repos
set org-wide base permission from read => none
agreement that hyphacoop/organizing labels work for now
agreement on repos to sync to (see attached PR)
Write config file Added sync-labels workflow for GitHub Actions #146
Document how to update => Add guide for updating labels handbook#39
Enable syncing
Test it

The text was updated successfully, but these errors were encountered:

patcon · 2019-11-14T23:02:43Z

Or instead of defining a config and making a people-run sync process, we could just 💡 choose a canonical repo to base the labels off of, and have a script run in CircleCI to generate a config, then it against every other org repo #zeroconfig style :)

Related: https://github.com/popomore/github-labels#export-from-github-website

GitHub Actions can even trigger the script to run every time the labels are editted/created/deleted:
https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#label-event-label

patcon · 2019-11-14T23:11:14Z

Exported, in case we want to use this: label-config.json

[
  {
    "name": "blocked",
    "color": "d73a4a"
  },
  {
    "name": "[priority-★★★]",
    "color": "ff7f00"
  },
  {
    "name": "[priority-★★☆]",
    "color": "ffaa00"
  },
  {
    "name": "[priority-★☆☆]",
    "color": "ffd400"
  },
  {
    "name": "proj:aether",
    "color": "8540ad"
  },
  {
    "name": "proj:primal-glow",
    "color": "8540ad"
  },
  {
    "name": "proj",
    "color": "8540ad"
  },
  {
    "name": "wg:business-planning",
    "color": "bfd4f2"
  },
  {
    "name": "wg:finance",
    "color": "bfd4f2"
  },
  {
    "name": "wg:governance",
    "color": "bfd4f2"
  },
  {
    "name": "wg:infra-ops",
    "color": "bfd4f2"
  }
]

patcon · 2019-11-15T02:56:42Z

Ok quick demo set up in hyphacoop/demo-repo, in case it works for us. (Was looking for excuse to learn GitHub Actions, so no pressure to use this.)

Just change the labels here (color or rename):
https://github.com/hyphacoop/demo-repo/labels

And it will create/delete or modify colors of labels here:
https://github.com/patcon/archive-demo/labels
https://github.com/patcon/label-sync-demo/labels

This is done via:
https://github.com/hyphacoop/demo-repo/blob/master/.github/workflows/label-sync.yml#L16-L17

Using the github-sync command, which has a clever "prune" variant of strict label syncing: this will delete labels from target repo that are missing from source repo, but only if the target label is unused.

Important: Renaming a label that's in-use (the vast majority use-case outside a demo) would be a two-step process:

Rename label in organizing (canonical repo), e.g. label old => label new
- tool goes to work creating label new in the target repo, and it would remove label old, but won't right away, since it's in-use.
Then in the target repo issue listing, user can do a 4-click edit: (1) click label to filter for label:"label old", (2) click to select all, then (3&4) click twice in the "Label" action drop-down to bulk edit to remove label old and adding label new on every issue at once.

benhylau · 2019-11-18T09:29:29Z

This sounds fine to me as a starting point. In the future it's possible we'd want one repo to have more labels, but I think we shouldn't worry until that happens. Right now, organizing has the best set of labels.