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

chore(ci): add labels sync workflow #452

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Conversation

jbcaron
Copy link
Member

@jbcaron jbcaron commented Jan 6, 2025

Pull Request type

Please add the labels corresponding to the type of changes your PR introduces:

  • Build-related changes

What is the current behavior?

Currently, there is no automated system to manage github labels. Label creation and modification is done manually through the github interface.

Resolves: #NA

What is the new behavior?

  • Added github action workflow (EndBug/label-sync@v2) to manage labels automatically
  • Labels configuration in a versioned YAML file .github/config/labels.yml
  • Ability to trigger synchronization manually via workflow_dispatch on main branch
  • Support for label renaming using the 'aliases' property in the config file

Does this introduce a breaking change?

No

Other information

This PR provides a single source of truth for github labels and facilitates their maintenance over time.

@jbcaron jbcaron self-assigned this Jan 6, 2025
@jbcaron jbcaron force-pushed the chore/add-labels-sync-workflow branch from 8ce5995 to 92093b9 Compare January 6, 2025 15:20
@Trantorian1 Trantorian1 added the infrastructure CI/CD, deployment and infrastructure changes label Jan 7, 2025
Copy link
Collaborator

@Trantorian1 Trantorian1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good but needs some formatting of labels.yml. Right now its a bit hard to decypher.

Comment on lines 2 to 12
- name: bug
color: d73a4a
description: Report an issue or unexpected behavior
- name: feature
color: a2eeef
description: Request for new feature or enhancement
aliases:
- enhancement
- name: question
color: d876e3
description: Request for information or clarification
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a line break between labels. I'm finding this pretty hard to ready atm with the density of it.

Suggested change
- name: bug
color: d73a4a
description: Report an issue or unexpected behavior
- name: feature
color: a2eeef
description: Request for new feature or enhancement
aliases:
- enhancement
- name: question
color: d876e3
description: Request for information or clarification
- name: bug
color: d73a4a
description: Report an issue or unexpected behavior
- name: feature
color: a2eeef
description: Request for new feature or enhancement
aliases:
- enhancement
- name: question
color: d876e3
description: Request for information or clarification

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current format follows the conventional YAML style guide where related metadata labels are kept together

@jbcaron jbcaron requested a review from Trantorian1 January 7, 2025 15:06
@jbcaron jbcaron force-pushed the chore/add-labels-sync-workflow branch from 92093b9 to 50ecdf6 Compare January 7, 2025 15:29
Copy link
Contributor

@notlesh notlesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, although I agree that labels.yml is difficult to read.

@antiyro antiyro merged commit c03c8b1 into main Jan 8, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure CI/CD, deployment and infrastructure changes
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants