Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write or identify tooling for maintaining consistent labels across multiple repositories #270

Open
2 of 3 tasks
larsks opened this issue May 26, 2021 · 13 comments
Open
2 of 3 tasks
Assignees
Labels
size/medium Similar work has been done before, it is clear what needs to be done, a few steps beyond a small.

Comments

@larsks
Copy link
Member

larsks commented May 26, 2021

We want to use labels for project planning, but labels are local per repository. We need a tool for ensuring that all of our repositories share at least a base set of labels. There are three major subtasks to complete for this issue:

  • What's our label vocabulary? Before we can talk about propagating a common set of labels to our repositories, we need to figure out which labels form our common taxonomy (Propose a common taxonomy for issue and pr labels ops-docs#15).
  • What repositories do we manage? We could just pick "everything in the cci-moc organization", but that might not be appropriate. There are 150 or so repositories, and some may be managed by people outside of the core ops team.
  • How do we synchronize the labels? This is the only strictly technical question in this bunch.
@larsks
Copy link
Member Author

larsks commented May 27, 2021

https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63 has some interesting thoughts on label taxonomy, which is somewhat related to this issue.

@larsks
Copy link
Member Author

larsks commented May 27, 2021

There is a label-syncer action for GitHub workflows that seems recently maintained. It's in use by a number of projects. I've submitted a pull request to allow label renaming, which I think we'll need if we decide to adopt a more consistent taxonomy:

micnncim/action-label-syncer#60

@larsks
Copy link
Member Author

larsks commented May 27, 2021

This will be very helpful once we resolve #241 (because we can propagate sizing labels to all our repositories).

@larsks
Copy link
Member Author

larsks commented May 27, 2021

https://seantrane.com/posts/logical-colorful-github-labels-18230/ also has some interesting thoughts on both taxonomy and color

@larsks
Copy link
Member Author

larsks commented May 27, 2021

https://github.com/Financial-Times/github-label-sync#configuration seems a little more feature-complete already

@larsks larsks self-assigned this Jun 15, 2021
larsks added a commit to larsks/ops-policy that referenced this issue Jun 15, 2021
larsks added a commit to larsks/ops-policy that referenced this issue Jun 15, 2021
Propose a new spec that desacribes a common label taxonomy to be
applied to (all/many of) our GitHub repositories. This will permit us
to more effectively use labels as part of our planning process.

Part of CCI-MOC/ops-issues#270
larsks added a commit to CCI-MOC/moc-labels that referenced this issue Jun 16, 2021
This repository contains the standard label taxonomy for MOC
repositories as well as tooling to apply the taxonomy to selected
repositories.

Part of CCI-MOC/ops-issues#270
larsks added a commit to CCI-MOC/gh-tools-image that referenced this issue Jun 16, 2021
This image is used by MOC GitHub workflows that interact with our
GitHub repositories.

Part of CCI-MOC/ops-issues#270
larsks added a commit to CCI-MOC/moc-labels that referenced this issue Jun 16, 2021
This repository contains the standard label taxonomy for MOC
repositories as well as tooling to apply the taxonomy to selected
repositories.

Part of CCI-MOC/ops-issues#270
@larsks
Copy link
Member Author

larsks commented Jun 16, 2021

To summarize the related changes here:

larsks added a commit to larsks/ops-policy that referenced this issue Jun 16, 2021
Propose a new spec that desacribes a common label taxonomy to be
applied to (all/many of) our GitHub repositories. This will permit us
to more effectively use labels as part of our planning process.

Part of CCI-MOC/ops-issues#270
@joachimweyl joachimweyl added the size/small Small thought and effort required, similar work has been done, or extra small with small unknown. label May 24, 2022
@larsks larsks added size/medium Similar work has been done before, it is clear what needs to be done, a few steps beyond a small. and removed size/small Small thought and effort required, similar work has been done, or extra small with small unknown. labels May 25, 2022
@joachimweyl
Copy link
Contributor

@larsks sounds like we should update our taxonomy to include our size labels. Are there any other taxonomy updates we should make?

@larsks
Copy link
Member Author

larsks commented Jun 3, 2022

Agree re: adding size/ labels. I'm not sure I can think of anything else we need.

@joachimweyl
Copy link
Contributor

I have opened #589 to ensure the taxonomy page is up to date. This should not block continuing to research how to do this but it will block the final creation as we need to make sure all repos have the same base label set.

@joachimweyl joachimweyl added the blocked Include reason issue is blocked in the description label Jun 3, 2022
@joachimweyl
Copy link
Contributor

As the taxonomy page modifies some of the labels that already exist such as help wanted becomes flag/help wanted. Will we also have a way to remove these "duplicates"?
I noticed that we have 2 pages that house taxonomy information. moc-labels and taxonomy. Do we really want to maintain two versions?

@larsks
Copy link
Member Author

larsks commented Jun 3, 2022

The policy document is authoritative.

The moc-labels repository contains an implementation (that we're not currently using); documentation there is informative ("this is what this code does"), but it's not a policy.

@joachimweyl joachimweyl removed the blocked Include reason issue is blocked in the description label Jun 8, 2022
@hakasapl
Copy link

@larsks I can work on deploying https://github.com/Financial-Times/github-label-sync if it's okay with you?

@larsks
Copy link
Member Author

larsks commented Jun 27, 2022

@hakasapl I'm not sure I actually want to go that route. Let me add some updates to this issue this afternoon about alternate tooling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/medium Similar work has been done before, it is clear what needs to be done, a few steps beyond a small.
Projects
None yet
Development

No branches or pull requests

4 participants