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

Improve documentation about GitHub label management #408

Open
2 tasks
codificat opened this issue May 11, 2022 · 2 comments
Open
2 tasks

Improve documentation about GitHub label management #408

codificat opened this issue May 11, 2022 · 2 comments
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@codificat
Copy link
Member

Problem statement

As a contributor to one of the Thoth GitHub repos, it is unclear to me how the labels that are available in each repo are maintained.

The current reference in the
README

is not sufficient. It does not explain:

  • when does prow update the labels
  • how/if a manual update to the labels can be requested

High-level Goals

Explain the workflow to maintain the repo labels in more detail:

  • clarify the relationship between labels.yaml, labels.md, and the actual labels available in GitHub
  • the prow configuration that checks and implements the changes
  • how to trigger a label update in the repos

Additional context

This need arose after the recent addition of a new repository in the org: https://github.com/thoth-station/thoth-github-action

That repository did not get the labels configured, and it is unclear from the current documents why this did not happen and how to fix it.

Acceptance Criteria

Documentation exists about:

  • when/how are labels updated in a GitHub repo
  • how to manually trigger updates
@sesheta sesheta added needs-triage Indicates an issue or PR lacks a `triage/...` label and requires one. needs-sig labels May 11, 2022
@codificat
Copy link
Member Author

/sig user-experience
/triage accepted
/assign

@sesheta sesheta added sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-sig needs-triage Indicates an issue or PR lacks a `triage/...` label and requires one. labels May 11, 2022
@goern
Copy link
Member

goern commented Aug 9, 2022

/kind feature

@sesheta sesheta added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 9, 2022
@codificat codificat moved this to 📋 Backlog in Planning Board Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants