Skip to content

Commit ebd849f

Browse files
authored
Merge pull request #394 from scottrigby/document-maintainer-groups
HIP: Document and Track maintainer groups
2 parents fcdf969 + 15d0a49 commit ebd849f

File tree

4 files changed

+151
-42
lines changed

4 files changed

+151
-42
lines changed

Teams.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

hips/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ restricted markdown format and can be found in the
1818
- [hip-0004: Document backwards-compatibility rules](hip-0004.md)
1919
- [hip-0005: Helm Org Maintainers and Deprecated Projects](hip-0005.md)
2020
- [hip-0006: OCI Support](hip-0006.md)
21+
- [hip-0007: Document and Track maintainer groups](hip-0007.md)
2122
- [hip-0008: Add descriptions to custom completions](hip-0008.md)
2223
- [hip-0009: Transitioning Security Team Members on Project Deprecation](hip-0009.md)
2324
- [hip-0010: Distributed responsibility for picking](hip-0010.md)
@@ -34,4 +35,4 @@ restricted markdown format and can be found in the
3435
- [hip-0023: Utilize Server Side Apply for installs/upgrades](hip-0023.md)
3536
- [hip-0024: Improve the Helm Documentation](hip-0024.md)
3637
- [hip-0025: Better Support for Resource Creation Sequencing](hip-0025.md)
37-
- [hip:0026: H4HIP: Wasm plugin system](hip-0026.md)
38+
- [hip-0026: H4HIP: Wasm plugin system](hip-0026.md)

hips/hip-0007.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
hip: "0007"
3+
title: "Document and Track maintainer groups"
4+
authors: [ "Matt Farina <[email protected]>", "Scott Rigby <[email protected]>" ]
5+
created: "2025-10-07"
6+
type: "process"
7+
status: "draft"
8+
---
9+
10+
## Abstract
11+
12+
There are numerous Helm maintainer groups where each can have zero or more Git
13+
repositories associated with them. This process provides a centralized method
14+
to document and track the maintainer groups, maintainers, and associated repos.
15+
16+
## Motivation
17+
18+
The current design uses a collection of documented and access controls to track
19+
this information while there are several gaps in the information. The Teams.md
20+
file attempted to track the different teams (i.e. maintainer groups, the org
21+
maintainers, etc).
22+
23+
The repositories owned by a maintainer group, and the members of a group are
24+
not documented but are instead tracked via GitHub teams. The owners are
25+
scattered in various locations that are not consistent. In some cases they
26+
cannot be consistent (e.g. community management which does not have a GitHub
27+
repo). This has lead to confusion with the Org Maintainers and others.
28+
29+
## Rationale
30+
31+
There is currently no consistent manner to document the codebases associated with
32+
a maintainer group or the members of a maintainer group. There are two examples we can look
33+
at for this situation.
34+
35+
First, there are maintainer groups responsible for multiple repositories. Charts and the
36+
Org maintainers groups are two examples with multiple repositories.
37+
There is no location to publicly document this situation.
38+
39+
Second, not all maintainer groups own a repository. Community management is an example
40+
of a maintainer group that does a significant amount of work without owning a source
41+
repository.
42+
43+
This HIP aims to provide a single source of document to discover maintainer group
44+
repositories and owners.
45+
46+
## Specification
47+
48+
The source of truth will be a YAML file name [`maintainer-groups.yaml`](../maintainer-groups.yaml)
49+
stored at the root of the Helm community repository. It will have the following
50+
structure:
51+
52+
```
53+
maintainerGroups:
54+
- name: Helm Core
55+
ownersLink: https://raw.githubusercontent.com/helm/helm/master/OWNERS
56+
repos:
57+
- https://github.com/helm/helm
58+
mailingList: [email protected]
59+
- name: Charts
60+
owners:
61+
- unguiculus
62+
- ...
63+
emeritus:
64+
- foxish
65+
- ...
66+
repos:
67+
- https://github.com/helm/chart-releaser-action
68+
- https://github.com/helm/charts-repo-actions-demo
69+
- ...
70+
```
71+
72+
A maintainer group can only have either `ownersLink` (a URL to the location of the
73+
owners list) or `owners` (a list of owners). It cannot have both. This enables
74+
those who do not have a Git repo (e.g., community managers) and those with
75+
multiple repos and no primary one (e.g., charts) to have a documented list.
76+
77+
When `owners` is used it can have an accompanying `emeritus`. When `ownersLink`
78+
is used the emeritus is expected to be listed in that file.
79+
80+
## References
81+
82+
* [Helm Governance](https://github.com/helm/community/blob/master/governance/governance.md)
83+
documents maintainer groups.
84+
* The [Teams.md file can be referenced in the community history](https://github.com/helm/community/blob/ecedb3ddea57749580bc4800cb1492fce9c9b332/Teams.md).

maintainer-groups.yaml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
maintainerGroups:
2+
- name: Helm Org Maintainers
3+
ownersLink: https://github.com/helm/community/blob/main/MAINTAINERS.md
4+
repos:
5+
- https://github.com/helm/community
6+
- https://github.com/helm/pull-sizer
7+
- https://github.com/helm/specs
8+
- https://github.com/helm/query-store-quay-logs
9+
- https://github.com/helm/github-webhook-dco-labeler
10+
- https://github.com/helm/charts-check-pr-title
11+
- https://github.com/helm/repo-audit
12+
- https://github.com/helm/examples
13+
mailingList: [email protected]
14+
- name: Security team
15+
ownersLink: https://github.com/helm/community/blob/main/SECURITY.md
16+
mailingList: [email protected]
17+
- name: Helm Core
18+
ownersLink: https://raw.githubusercontent.com/helm/helm/master/OWNERS
19+
repos:
20+
- https://github.com/helm/helm
21+
mailingList: [email protected]
22+
- name: Charts
23+
owners:
24+
- lachie83
25+
- sameersbn
26+
- unguiculus
27+
- scottrigby
28+
- mattfarina
29+
- davidkarlsen
30+
- paulczar
31+
- cpanato
32+
- jlegrone
33+
- maorfr
34+
emeritus:
35+
- foxish
36+
- linki
37+
- mgoodness
38+
- prydonius
39+
- seanknox
40+
- viglesiasce
41+
repos:
42+
- https://github.com/helm/chart-releaser-action
43+
- https://github.com/helm/charts-repo-actions-demo
44+
- https://github.com/helm/chart-testing-action
45+
- https://github.com/helm/chart-testing
46+
- https://github.com/helm/charts-tooling
47+
- https://github.com/helm/chart-releaser
48+
- https://github.com/helm/homebrew-tap
49+
- https://github.com/helm/kind-action
50+
mailingList: [email protected]
51+
- name: Website
52+
ownersLink: https://raw.githubusercontent.com/helm/helm-www/master/OWNERS
53+
repos:
54+
- https://github.com/helm/helm-www
55+
- name: Community Management
56+
owners:
57+
- karenhchu
58+
- name: Chartmuseum
59+
ownersLink: https://raw.githubusercontent.com/helm/chartmuseum/main/OWNERS
60+
repos:
61+
- https://github.com/helm/chartmuseum
62+
- name: Mapkubeapis plugin
63+
ownersLink: https://github.com/helm/helm-mapkubeapis/blob/main/OWNERS
64+
repos:
65+
- https://github.com/helm/helm-mapkubeapis

0 commit comments

Comments
 (0)