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

docs: Add responsibles label to ocmcli component descriptor #1233

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

8R0WNI3
Copy link
Member

@8R0WNI3 8R0WNI3 commented Jan 9, 2025

What this PR does / why we need it

The responsibles label is used to automatically assign detected compliance issues to the responsible GitHub team. If no such responsibles are configured, GitHub repository statistics will be heuristically examined to determine the respective responsibles, however, these statistics are not properly created for this repository.

Which issue(s) this PR fixes

The responsibles label is used to automatically assign detected
compliance issues to the responsible GitHub team. If no such
responsibles are configured, GitHub repository statistics will be
heuristically examined to determine the respective responsibles,
however, these statistics are not properly created for this repository.
@8R0WNI3 8R0WNI3 requested a review from a team as a code owner January 9, 2025 07:11
@github-actions github-actions bot added component/ocm-cli OCM Command Line Interface size/xs Extra small labels Jan 9, 2025
Copy link
Contributor

github-actions bot commented Jan 9, 2025

Mend Scan Summary: ❌

Repository: open-component-model/ocm

VIOLATION DESCRIPTION NUMBER OF VIOLATIONS
HIGH/CRITICAL SECURITY VULNERABILITIES 5
MAJOR UPDATES AVAILABLE 0
LICENSE REQUIRES REVIEW 2
HIGH RISK LICENSES 9
RESTRICTIED LICENSE FOR ON-PREMISE DELIVERY 0

Detailed Logs: mend-scan-> Generate Report
Mend UI

@8R0WNI3 8R0WNI3 changed the title Add responsibles label to ocmcli component descriptor docs: Add responsibles label to ocmcli component descriptor Jan 9, 2025
@github-actions github-actions bot added the area/documentation Documentation related label Jan 9, 2025
@8R0WNI3 8R0WNI3 added the kind/chore chore, maintenance, etc. label Jan 9, 2025


labels:
- name: cloud.gardener.cnudie/responsibles
Copy link
Contributor

Choose a reason for hiding this comment

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

Since this label is opinionated, I am not sure if we should really accept this. if at all it should be ocm.software/responsibles. WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

seems to be related to naming conventions discussions for "standard" labels that we expect to be used with OCM we had in the past, but never productively continued / finished :-)

The OCM spec differentiates between labels with a specific meaning inside of OCM and others, vendor specific ones (see here. cloud.gardener.cnudie/responsible would fall in "vendor-specific", but is very "standard" as many teams will have a need for them.

Therefore I support Jacob's proposal and start having a set of "standard" labels in the ocm.software namespace that we offer and use in our examples and OCM owned components.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree it will likely be a good idea to have a registry of "wellknown" labels (I started an internal one here). I also agree we should eventually drop cnudie.

Considering, however, that we might see similar cases in the future, how about adding an aliases-attr to labels? Also, I would very much appreciate it so see a registry of well-known labels at this github-organisation (those might be a good fit as additional language-bindings - ours (note that the package(-name) did not age well / is subject to being refactored).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related component/ocm-cli OCM Command Line Interface kind/chore chore, maintenance, etc. size/xs Extra small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants