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

feat: Label renaming and import statements #68

Open
wants to merge 14 commits into
base: master
Choose a base branch
from

Conversation

joeyparrish
Copy link

This adds two main features: label renaming and import statements.

Label renaming is an extension of the work done by @larsks in PR #60. To the renaming support in #60 (alias field), I added a list-of-strings field called aliases, to better support single configs that can be used across repositories. For example, each repo could have a different existing bug label that you may to rename to unify them:

- name: "Type: bug"
  aliases:
    - bug
    - defect
  description: Something isn't working
  color: d73a4a

The import statement further enhances our ability to share configs across repos. Common fields needed by all repos (such as Type: bug) could be placed in a common config file. Then, each repo has its own config file with its unique labels, and the common ones get imported. For example:

# common.yaml
- name: "Type: bug"
  aliases:
    - bug
    - defect
  description: Something isn't working
  color: d73a4a
# repo1.yaml
- import: common.yaml

- name: "Platform: iOS"
  description: Issues specific to iOS
  color: d73a4a

Finally, this makes some additional changes I found useful in testing and development:

  • Error early instead of trying to change a label with a question mark in the name.
  • Error early if description is too long. GitHub will reject these labels, so we should identify them early and provide a clear message.
  • Serialize label changes. Doing them in parallel does not make the process much faster, but it does make the logs more difficult to read.
  • Fix silent errors from main.
  • Add dry-run flag. Useful for testing a large migration before making it final.

Closes #59

larsks and others added 14 commits May 27, 2021 10:16
Introduce the "alias" attribute for labels so that label-syncer can
rename labels, rather than deleting/re-creating them. This preserves
labels on existing issues and pull requests.

Closes micnncim#59
This is useful when syncing labels across many projects with one
config.  If some projects used different label names originally, the
new versions may need multiple aliases.
Now you can import labels from another file that is common to multiple projects.
GitHub will reject these labels, so we should identify them early and provide a clear message.
I am learning go!
For a large migration, it will be useful to have a dry-run to see what changes would be made before they are actually made
Doing them in parallel does not make the process much faster, but it does make the logs more difficult to read.  Just do it serially instead.
…in the name

The GitHub client likely needs to be fixed to properly escape label names when updating or deleting them.  In the meantime, just error early and make the user rename those manually first.
@joeyparrish
Copy link
Author

@larsks, @micnncim, please let me know if you have any feedback. Thanks!

@joeyparrish
Copy link
Author

@micnncim, I can continue using my fork indefinitely if I must, but I always prefer to contribute upstream. Please let me know if you have feedback. Thanks!

@micnncim
Copy link
Owner

Sorry for being too late. Some feedback I can give you as of now:

  • Please separate the PR per feature/fix
  • Please create an issue for the import feature and discuss it there

This would make your change easier to be merged into this project.

@joeyparrish
Copy link
Author

Issue #59 already existed for the renaming feature. I've updated it with the details of my extension to allow multiple aliases.

I've filed #69 for the import feature.

@maxisam
Copy link

maxisam commented Jan 19, 2024

This is a really nice feature. Any chance to merge this?

@joeyparrish
Copy link
Author

I never got around to splitting this up the way the maintainer wanted. I'm lazily using a fork in my workflows: joeyparrish/[email protected]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow label renaming
4 participants