Giters

micnncim / action-label-syncer

GitHub Action to sync GitHub labels in the declarative way

Home Page:https://github.com/marketplace/actions/label-syncer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Clarify label sync behavior

br3ndonland opened this issue · comments

commented

Thanks for this action, it's really helpful.

It would be helpful to clarify the behavior of the action. Based on using the action and reading github.go, it appears to be doing the following:

  • If a label color changes, the same label is updated with the new color
  • If a label name changes, the previous label is deleted. All issues and PRs that were previously labeled with this label are now unlabeled.

Is this correct?

I'm happy to submit a PR to update the README with this info.

commented

I would also like to see this behavior documented.

It's not clear to me if the repository using a source repo as a reference will remove any custom labels that are not included in that repository.

It's not clear to me if the reference file is only sourced from the specified repository or if a local copy of that file could be used to append labels to the list.

commented

Sorry for the late reply 🙇‍♂️

  • If a label color changes, the same label is updated with the new color
  • If a label name changes, the previous label is deleted. All issues and PRs that were previously labeled with this label are now unlabeled.

Your assumption is correct! So please be careful if you try to change label names.