Skip to content

Commit c8ed1c6

Browse files
committed
chore(ci): adopt CNCF/k8s label conventions
Add .github/labels.yml as the canonical label set, synced into the repository by .github/workflows/labels.yaml using EndBug/label-sync. Conventions follow the Kubernetes scheme: https://github.com/kubernetes/test-infra/blob/master/label_sync/labels.md Six namespaced groups: kind/, priority/, triage/, lifecycle/, area/, do-not-merge/. Cozystack-specific labels preserved (epic, community, security/*, size:*). Migration via aliases keeps references on existing issues and PRs: - bug -> kind/bug - enhancement -> kind/feature - documentation -> kind/documentation - question -> kind/support - frozen -> lifecycle/frozen - stale -> lifecycle/stale - do-not-merge -> do-not-merge/work-in-progress delete-other-labels is false on the initial rollout; redundant labels ("do not merge", duplicate, invalid, wontfix) stay until a follow-up PR removes them after stabilisation. The labels workflow has a validate job (python3 schema check) that runs on PR. Sync runs only on push to main, weekly cron, and manual dispatch. Schema invariants: - description <= 100 chars (GitHub REST API limit) - color is 6-char hex without leading # - unique top-level names - aliases do not collide with top-level names PR auto-labeling (.github/workflows/pr-labeler.yaml): - Parses PR title as Conventional Commits header (type, scope, !). - type -> kind/* (feat -> kind/feature, fix -> kind/bug, docs -> kind/documentation, chore/refactor -> kind/cleanup; style, perf, test, build, ci, revert -> no kind label). - scope -> area/* via embedded mapping; composite scopes split on comma. Bracket-style fallback ([scope] description) maps area/* but cannot infer kind/*. - '[Backport release-1.x]' prefix is stripped; area/release and backport labels are added. - '!' after type or 'BREAKING CHANGE:' footer in body adds kind/breaking-change. - Unmapped scope or non-conventional title adds area/uncategorized to flag for human review. - Additive only — never removes existing labels. Hardcoded label references updated: - .github/ISSUE_TEMPLATE/bug_report.md (bug -> kind/bug) - .github/workflows/tags.yaml (documentation -> kind/documentation) AGENTS.md gains an Activation entry pointing agents to labels.yml as the source of truth and to contributing.md for the title auto-labeling table. Assisted-By: Claude <[email protected]> Signed-off-by: Aleksei Sviridkin <[email protected]>
1 parent 52edffb commit c8ed1c6

7 files changed

Lines changed: 707 additions & 4 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
labels: 'bug'
4+
labels: 'kind/bug'
55
assignees: ''
66

77
---

‎.github/labels.yml‎

Lines changed: 371 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,371 @@
1+
# Cozystack repository labels
2+
#
3+
# Label conventions follow the Kubernetes scheme:
4+
# https://github.com/kubernetes/test-infra/blob/master/label_sync/labels.md
5+
#
6+
# Synced into the repository by .github/workflows/labels.yaml
7+
# (EndBug/label-sync@v2). Edit this file via pull request — UI changes
8+
# will be overwritten on the next sync.
9+
#
10+
# Constraints (enforced by the validate job in labels.yaml):
11+
# - description ≤ 100 characters (GitHub REST API limit)
12+
# - color is a 6-character hex string (no leading #)
13+
# - label names are unique
14+
# - aliases do not collide with top-level names
15+
#
16+
# Categories:
17+
# kind/ issue or PR type
18+
# priority/ urgency
19+
# triage/ review state
20+
# lifecycle/ issue or PR lifecycle
21+
# area/ subsystem; extensible — add when 3+ open issues exist
22+
# do-not-merge/ PR merge blockers
23+
# security/ security-finding severity and status (Cozystack-specific)
24+
# size: PR size (auto-applied)
25+
#
26+
# `aliases:` lets EndBug/label-sync rename existing labels without losing
27+
# references on already-tagged issues and PRs.
28+
#
29+
# GitHub-default labels not migrated here (`wontfix`, `invalid`) currently
30+
# carry zero issues/PRs in this repo and will be removed in a follow-up
31+
# cleanup PR rather than aliased to a different namespace.
32+
33+
# ──────────────────────────────────────────────
34+
# kind/ — issue or PR type
35+
# ──────────────────────────────────────────────
36+
37+
- name: kind/bug
38+
color: 'd73a4a'
39+
description: Categorizes issue or PR as related to a bug
40+
aliases: ['bug']
41+
42+
- name: kind/feature
43+
color: 'a2eeef'
44+
description: Categorizes issue or PR as related to a new feature
45+
aliases: ['enhancement']
46+
47+
- name: kind/documentation
48+
color: '0075ca'
49+
description: Categorizes issue or PR as related to documentation
50+
aliases: ['documentation']
51+
52+
- name: kind/support
53+
color: 'd876e3'
54+
description: Categorizes issue as a support question
55+
aliases: ['question']
56+
57+
- name: kind/cleanup
58+
color: 'c7def8'
59+
description: Categorizes issue or PR as related to cleanup of code, process, or technical debt
60+
61+
- name: kind/regression
62+
color: 'e11d21'
63+
description: Categorizes issue or PR as related to a regression from a prior release
64+
65+
- name: kind/flake
66+
color: 'f7c6c7'
67+
description: Categorizes issue or PR as related to a flaky test
68+
69+
- name: kind/failing-test
70+
color: 'e11d21'
71+
description: Categorizes issue or PR as related to a consistently or frequently failing test
72+
73+
- name: kind/api-change
74+
color: 'c7def8'
75+
description: Categorizes issue or PR as related to adding, removing, or otherwise changing an API
76+
77+
- name: kind/breaking-change
78+
color: 'e11d21'
79+
description: Indicates the change introduces a breaking API or behaviour change
80+
81+
# ──────────────────────────────────────────────
82+
# priority/ — urgency
83+
# ──────────────────────────────────────────────
84+
85+
- name: priority/critical-urgent
86+
color: 'e11d21'
87+
description: Highest priority. Must be actively worked on as someone's top priority right now
88+
89+
- name: priority/important-soon
90+
color: 'eb6420'
91+
description: Must be staffed and worked on either currently, or very soon, ideally in time for the next release
92+
93+
- name: priority/important-longterm
94+
color: 'fbca04'
95+
description: Important over the long term, but may not be staffed and/or may need multiple releases to complete
96+
97+
- name: priority/backlog
98+
color: 'fef2c0'
99+
description: General backlog priority. Lower than priority/important-longterm
100+
101+
# ──────────────────────────────────────────────
102+
# triage/ — review state
103+
# ──────────────────────────────────────────────
104+
105+
- name: triage/needs-triage
106+
color: 'ededed'
107+
description: Indicates an issue needs triage by a maintainer
108+
109+
- name: triage/accepted
110+
color: '0e8a16'
111+
description: Indicates an issue is ready to be actively worked on
112+
113+
- name: triage/needs-information
114+
color: 'fbca04'
115+
description: Indicates an issue needs more information in order to work on it
116+
117+
- name: triage/not-reproducible
118+
color: 'fbca04'
119+
description: Indicates an issue can not be reproduced as described
120+
121+
- name: triage/duplicate
122+
color: 'cfd3d7'
123+
description: Indicates an issue is a duplicate of another issue
124+
aliases: ['duplicate']
125+
126+
- name: triage/unresolved
127+
color: 'cfd3d7'
128+
description: Indicates an issue that can not or will not be resolved
129+
130+
# ──────────────────────────────────────────────
131+
# lifecycle/ — issue or PR lifecycle
132+
# ──────────────────────────────────────────────
133+
134+
- name: lifecycle/active
135+
color: '1d76db'
136+
description: Indicates that an issue or PR is actively being worked on by a contributor
137+
138+
- name: lifecycle/frozen
139+
color: 'db5dd6'
140+
description: Indicates that an issue or PR should not be auto-closed due to staleness
141+
aliases: ['frozen']
142+
143+
- name: lifecycle/stale
144+
color: 'dadada'
145+
description: Denotes an issue or PR has remained open with no activity and has become stale
146+
aliases: ['stale']
147+
148+
- name: lifecycle/rotten
149+
color: '795548'
150+
description: Denotes an issue or PR that has aged beyond stale and will be auto-closed
151+
152+
# ──────────────────────────────────────────────
153+
# area/ — subsystem (extensible)
154+
# Add a new area/* when there are 3+ open issues on the topic.
155+
# ──────────────────────────────────────────────
156+
157+
- name: area/api
158+
color: 'bfd4f2'
159+
description: Issues or PRs related to the cozystack-api aggregated API server
160+
161+
- name: area/ai
162+
color: 'bfd4f2'
163+
description: Issues or PRs related to AI agent guides, AGENTS.md, docs/agents/
164+
165+
- name: area/build
166+
color: 'bfd4f2'
167+
description: Issues or PRs related to image build infrastructure, multi-arch support
168+
169+
- name: area/ci
170+
color: 'bfd4f2'
171+
description: Issues or PRs related to CI workflows, GitHub Actions, automation
172+
173+
- name: area/dashboard
174+
color: 'bfd4f2'
175+
description: Issues or PRs related to the dashboard / UI
176+
177+
- name: area/extra
178+
color: 'bfd4f2'
179+
description: Issues or PRs related to tenant-specific modules (packages/extra/)
180+
181+
- name: area/database
182+
color: 'bfd4f2'
183+
description: Issues or PRs related to managed databases (postgres, mariadb, redis, etcd, kafka, clickhouse)
184+
185+
- name: area/kubernetes
186+
color: 'bfd4f2'
187+
description: Issues or PRs related to the tenant Kubernetes app
188+
189+
- name: area/monitoring
190+
color: 'bfd4f2'
191+
description: Issues or PRs related to the monitoring stack (vlogs, vmstack, grafana, workloadmonitor)
192+
193+
- name: area/networking
194+
color: 'bfd4f2'
195+
description: Issues or PRs related to networking (ingress, gateway, vpn, metallb, cilium, kube-ovn)
196+
197+
- name: area/platform
198+
color: 'bfd4f2'
199+
description: Issues or PRs related to platform infrastructure (bundle, flux, talos, installer)
200+
201+
- name: area/release
202+
color: 'bfd4f2'
203+
description: Issues or PRs related to release tooling (changelog, backport, release pipeline)
204+
205+
- name: area/storage
206+
color: 'bfd4f2'
207+
description: Issues or PRs related to storage (linstor, seaweedfs, bucket, velero, harbor)
208+
209+
- name: area/testing
210+
color: 'bfd4f2'
211+
description: Issues or PRs related to testing (e2e, bats, unit tests)
212+
213+
- name: area/virtualization
214+
color: 'bfd4f2'
215+
description: Issues or PRs related to virtualization (kubevirt, cdi, vmi, vm-import)
216+
217+
- name: area/uncategorized
218+
color: 'fbca04'
219+
description: PR auto-labeler could not map title scope to a known area/*; please review
220+
221+
# ──────────────────────────────────────────────
222+
# do-not-merge/ — PR merge blockers (Prow convention)
223+
# ──────────────────────────────────────────────
224+
225+
- name: do-not-merge/work-in-progress
226+
color: 'e11d21'
227+
description: Indicates that a PR should not merge because it is a work in progress
228+
# Both legacy spellings collapse here. EndBug processes aliases sequentially;
229+
# the second rename hits a name collision and logs a warning — the legacy
230+
# label survives and gets cleaned up in the follow-up dedup PR.
231+
aliases: ['do-not-merge', 'do not merge']
232+
233+
- name: do-not-merge/hold
234+
color: 'e11d21'
235+
description: Indicates that a PR should not merge because someone has issued /hold
236+
237+
# ──────────────────────────────────────────────
238+
# Cozystack-specific (preserved)
239+
# ──────────────────────────────────────────────
240+
241+
- name: epic
242+
color: 'A335EE'
243+
description: A large development increment that brings definite value to Cozystack users
244+
245+
- name: community
246+
color: '97458A'
247+
description: Community contributions are welcome in this issue
248+
249+
- name: help wanted
250+
color: '008672'
251+
description: Extra attention is needed
252+
253+
- name: good first issue
254+
color: '7057ff'
255+
description: Good for newcomers
256+
257+
- name: quality-of-life
258+
color: 'aaaaaa'
259+
description: QoL improvements
260+
261+
- name: upstream-issue
262+
color: 'aaaaaa'
263+
description: Requires resolving an issue in an upstream project
264+
265+
- name: backport
266+
color: 'FBCA04'
267+
description: Should change be backported on previous release
268+
269+
- name: backport-previous
270+
color: 'fbd876'
271+
description: Backport target — previous release line
272+
273+
- name: release
274+
color: 'aaaaaa'
275+
description: Releasing a new Cozystack version
276+
277+
- name: automated
278+
color: 'ededed'
279+
description: Created by automation
280+
281+
- name: debug
282+
color: '704479'
283+
description: Debugging in progress
284+
285+
- name: sponsored
286+
color: '00FF00'
287+
description: Sponsored work
288+
289+
- name: lgtm
290+
color: '238636'
291+
description: This PR has been approved by a maintainer
292+
293+
- name: ok-to-test
294+
color: '00FF00'
295+
description: Indicates a non-member PR is safe to run CI on
296+
297+
# ──────────────────────────────────────────────
298+
# size: — PR size (auto-applied by sizing bot)
299+
# ──────────────────────────────────────────────
300+
301+
- name: 'size:XS'
302+
color: '00ff00'
303+
description: This PR changes 0-9 lines, ignoring generated files
304+
305+
- name: 'size:S'
306+
color: '77b800'
307+
description: This PR changes 10-29 lines, ignoring generated files
308+
309+
- name: 'size:M'
310+
color: 'ebb800'
311+
description: This PR changes 30-99 lines, ignoring generated files
312+
313+
- name: 'size:L'
314+
color: 'eb9500'
315+
description: This PR changes 100-499 lines, ignoring generated files
316+
317+
- name: 'size:XL'
318+
color: 'ff823f'
319+
description: This PR changes 500-999 lines, ignoring generated files
320+
321+
- name: 'size:XXL'
322+
color: 'ffb8b8'
323+
description: This PR changes 1000+ lines, ignoring generated files
324+
325+
# ──────────────────────────────────────────────
326+
# security/ — security-finding severity and status
327+
# ──────────────────────────────────────────────
328+
329+
- name: security
330+
color: 'aaaaaa'
331+
description: Security-related issues and features
332+
333+
- name: security/critical
334+
color: 'd73a4a'
335+
description: Critical security vulnerability
336+
337+
- name: security/high
338+
color: 'e99695'
339+
description: High severity security finding
340+
341+
- name: security/medium
342+
color: 'f9c513'
343+
description: Medium severity security finding
344+
345+
- name: security/low
346+
color: '0e8a16'
347+
description: Low severity security finding
348+
349+
- name: security/triage-needed
350+
color: 'fbca04'
351+
description: Needs security triage
352+
353+
- name: security/confirmed
354+
color: '1d76db'
355+
description: Confirmed vulnerability
356+
357+
- name: security/false-positive
358+
color: 'c5def5'
359+
description: Triaged as false positive
360+
361+
- name: security/accepted-risk
362+
color: 'bfd4f2'
363+
description: Risk accepted with justification
364+
365+
- name: security/in-progress
366+
color: '0075ca'
367+
description: Fix in progress
368+
369+
- name: security/fixed
370+
color: '0e8a16'
371+
description: Fix released

0 commit comments

Comments
 (0)