Skip to content

Commit 9ecc4d2

Browse files
authored
Merge pull request #5415 from nikhita/sigs-yaml-liaisons
Support Steering Committee liaisons in sigs.yaml
2 parents e517135 + 6288cb0 commit 9ecc4d2

File tree

42 files changed

+267
-9
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+267
-9
lines changed

generator/app.go

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,17 @@ import (
3131
)
3232

3333
const (
34-
readmeTemplate = "readme.tmpl"
35-
listTemplate = "list.tmpl"
36-
aliasesTemplate = "aliases.tmpl"
37-
headerTemplate = "header.tmpl"
38-
39-
sigsYamlFile = "sigs.yaml"
40-
sigListOutput = "sig-list.md"
41-
aliasesOutput = "OWNERS_ALIASES"
42-
indexFilename = "README.md"
34+
readmeTemplate = "readme.tmpl"
35+
listTemplate = "list.tmpl"
36+
aliasesTemplate = "aliases.tmpl"
37+
liaisonsTemplate = "liaisons.tmpl"
38+
headerTemplate = "header.tmpl"
39+
40+
sigsYamlFile = "sigs.yaml"
41+
sigListOutput = "sig-list.md"
42+
aliasesOutput = "OWNERS_ALIASES"
43+
indexFilename = "README.md"
44+
liaisonsFilename = "liaisons.md"
4345

4446
beginCustomMarkdown = "<!-- BEGIN CUSTOM CONTENT -->"
4547
endCustomMarkdown = "<!-- END CUSTOM CONTENT -->"
@@ -89,6 +91,7 @@ type Contact struct {
8991
MailingList string `yaml:"mailing_list,omitempty"`
9092
PrivateMailingList string `yaml:"private_mailing_list,omitempty"`
9193
GithubTeams []GithubTeam `yaml:"teams,omitempty"`
94+
Liaison Person `yaml:"liaison,omitempty"`
9295
}
9396

9497
// GithubTeam represents a specific Github Team.
@@ -527,5 +530,12 @@ func main() {
527530
log.Fatal(err)
528531
}
529532

533+
fmt.Println("Generating liaisons.md")
534+
outputPath = filepath.Join(baseGeneratorDir, liaisonsFilename)
535+
err = writeTemplate(filepath.Join(baseGeneratorDir, templateDir, liaisonsTemplate), outputPath, "markdown", ctx)
536+
if err != nil {
537+
log.Fatal(err)
538+
}
539+
530540
fmt.Println("Finished generation!")
531541
}

generator/committee_readme.tmpl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ The [charter]({{.CharterLink}}) defines the scope and governance of the {{.Name}
4949
- [@kubernetes/{{.Name}}](https://github.com/orgs/kubernetes/teams/{{.Name}}) {{- if .Description }} - {{.Description}} {{- end}}
5050
{{- end }}
5151
{{- end }}
52+
{{- if .Contact.Liaison.Name }}
53+
- Steering Committee Liaison: {{.Contact.Liaison.Name}} (**[@{{.Contact.Liaison.GitHub}}](https://github.com/{{.Contact.Liaison.GitHub}})**)
54+
{{- end }}
5255

5356
{{- if .Subprojects }}
5457

generator/liaisons.tmpl

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{{ template "header" }}
2+
3+
# Liaisons
4+
5+
Each community group in Kubernetes is assigned a Steering Committee
6+
liaison. Liaisons act as a point of contact from steering, engage with
7+
their respective community groups to ensure they are healthy and
8+
facilitate communication for [annual reports](committee-steering/governance/annual-reports.md).
9+
10+
Liaisons do not make decisions for the community group or on behalf of
11+
the Steering Committee.
12+
13+
Liaisons are assigned community groups at random (adjustments can be
14+
made, if needed) with each member having an (almost) equal distribution
15+
of SIGs, WGs and UGs.
16+
17+
| Community Group | Steering Committee Liaison |
18+
| -------------------------- | -------------------------- |
19+
{{- range .Sigs}}
20+
{{- if .Contact.Liaison.Name }}
21+
| [SIG {{.Name}}]({{.Dir}}/README.md) | {{.Contact.Liaison.Name}} (**[@{{.Contact.Liaison.GitHub}}](https://github.com/{{.Contact.Liaison.GitHub}})**) |
22+
{{- end }}
23+
{{- end -}}
24+
{{- range .WorkingGroups}}
25+
{{- if .Contact.Liaison.Name }}
26+
| [WG {{.Name}}]({{.Dir}}/README.md) | {{.Contact.Liaison.Name}} (**[@{{.Contact.Liaison.GitHub}}](https://github.com/{{.Contact.Liaison.GitHub}})**) |
27+
{{- end -}}
28+
{{- end }}
29+
{{- range .UserGroups}}
30+
{{- if .Contact.Liaison.Name }}
31+
| [UG {{.Name}}]({{.Dir}}/README.md) | {{.Contact.Liaison.Name}} (**[@{{.Contact.Liaison.GitHub}}](https://github.com/{{.Contact.Liaison.GitHub}})**) |
32+
{{- end -}}
33+
{{- end }}
34+
{{- range .Committees}}
35+
{{- if .Contact.Liaison.Name }}
36+
| [Committee {{.Name}}]({{.Dir}}/README.md) | {{.Contact.Liaison.Name}} (**[@{{.Contact.Liaison.GitHub}}](https://github.com/{{.Contact.Liaison.GitHub}})**) |
37+
{{- end -}}
38+
{{- end }}

generator/sig_readme.tmpl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ subprojects, and resolve cross-subproject technical issues and decisions.
5959
- [@kubernetes/{{.Name}}](https://github.com/orgs/kubernetes/teams/{{.Name}}) {{- if .Description }} - {{.Description}} {{- end}}
6060
{{- end }}
6161
{{- end }}
62+
{{- if .Contact.Liaison.Name }}
63+
- Steering Committee Liaison: {{.Contact.Liaison.Name}} (**[@{{.Contact.Liaison.GitHub}}](https://github.com/{{.Contact.Liaison.GitHub}})**)
64+
{{- end }}
6265

6366
{{- if .Subprojects }}
6467

generator/ug_readme.tmpl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,6 @@ The [charter]({{.CharterLink}}) defines the scope and governance of the {{.Name}
4747
- [@kubernetes/{{.Name}}](https://github.com/orgs/kubernetes/teams/{{.Name}}) {{- if .Description }} - {{.Description}} {{- end}}
4848
{{- end }}
4949
{{- end }}
50+
{{- if .Contact.Liaison.Name }}
51+
- Steering Committee Liaison: {{.Contact.Liaison.Name}} (**[@{{.Contact.Liaison.GitHub}}](https://github.com/{{.Contact.Liaison.GitHub}})**)
52+
{{- end }}

generator/wg_readme.tmpl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,6 @@ The [charter]({{.CharterLink}}) defines the scope and governance of the {{.Name}
5353
- [@kubernetes/{{.Name}}](https://github.com/orgs/kubernetes/teams/{{.Name}}) {{- if .Description }} - {{.Description}} {{- end}}
5454
{{- end }}
5555
{{- end }}
56+
{{- if .Contact.Liaison.Name }}
57+
- Steering Committee Liaison: {{.Contact.Liaison.Name}} (**[@{{.Contact.Liaison.GitHub}}](https://github.com/{{.Contact.Liaison.GitHub}})**)
58+
{{- end }}

liaisons.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<!---
2+
This is an autogenerated file!
3+
4+
Please do not edit this file directly, but instead make changes to the
5+
sigs.yaml file in the project root.
6+
7+
To understand how this file is generated, see https://git.k8s.io/community/generator/README.md
8+
--->
9+
10+
# Liaisons
11+
12+
Each community group in Kubernetes is assigned a Steering Committee
13+
liaison. Liaisons act as a point of contact from steering, engage with
14+
their respective community groups to ensure they are healthy and
15+
facilitate communication for [annual reports](committee-steering/governance/annual-reports.md).
16+
17+
Liaisons do not make decisions for the community group or on behalf of
18+
the Steering Committee.
19+
20+
Liaisons are assigned community groups at random (adjustments can be
21+
made, if needed) with each member having an (almost) equal distribution
22+
of SIGs, WGs and UGs.
23+
24+
| Community Group | Steering Committee Liaison |
25+
| -------------------------- | -------------------------- |
26+
| [SIG API Machinery](sig-api-machinery/README.md) | Davanum Srinivass (**[@dims](https://github.com/dims)**) |
27+
| [SIG Apps](sig-apps/README.md) | Bob Killen (**[@mrbobbytables](https://github.com/mrbobbytables)**) |
28+
| [SIG Architecture](sig-architecture/README.md) | Jordan Liggitt (**[@liggitt](https://github.com/liggitt)**) |
29+
| [SIG Auth](sig-auth/README.md) | Christoph Blecker (**[@cblecker](https://github.com/cblecker)**) |
30+
| [SIG Autoscaling](sig-autoscaling/README.md) | Derek Carr (**[@derekwaynecarr](https://github.com/derekwaynecarr)**) |
31+
| [SIG CLI](sig-cli/README.md) | Derek Carr (**[@derekwaynecarr](https://github.com/derekwaynecarr)**) |
32+
| [SIG Cloud Provider](sig-cloud-provider/README.md) | Nikhita Raghunath (**[@nikhita](https://github.com/nikhita)**) |
33+
| [SIG Cluster Lifecycle](sig-cluster-lifecycle/README.md) | Davanum Srinivas (**[@dims](https://github.com/dims)**) |
34+
| [SIG Contributor Experience](sig-contributor-experience/README.md) | Bob Killen (**[@mrbobbytables](https://github.com/mrbobbytables)**) |
35+
| [SIG Docs](sig-docs/README.md) | Jordan Liggitt (**[@liggitt](https://github.com/liggitt)**) |
36+
| [SIG Instrumentation](sig-instrumentation/README.md) | Christoph Blecker (**[@cblecker](https://github.com/cblecker)**) |
37+
| [SIG Multicluster](sig-multicluster/README.md) | Paris Pittman (**[@parispittman](https://github.com/parispittman)**) |
38+
| [SIG Network](sig-network/README.md) | Derek Carr (**[@derekwaynecarr](https://github.com/derekwaynecarr)**) |
39+
| [SIG Node](sig-node/README.md) | Nikhita Raghunath (**[@nikhita](https://github.com/nikhita)**) |
40+
| [SIG Release](sig-release/README.md) | Davanum Srinivas (**[@dims](https://github.com/dims)**) |
41+
| [SIG Scalability](sig-scalability/README.md) | Bob Killen (**[@mrbobbytables](https://github.com/mrbobbytables)**) |
42+
| [SIG Scheduling](sig-scheduling/README.md) | Jordan Liggitt (**[@liggitt](https://github.com/liggitt)**) |
43+
| [SIG Security](sig-security/README.md) | Paris Pittman (**[@parispittman](https://github.com/parispittman)**) |
44+
| [SIG Service Catalog](sig-service-catalog/README.md) | Christoph Blecker (**[@cblecker](https://github.com/cblecker)**) |
45+
| [SIG Storage](sig-storage/README.md) | Paris Pittman (**[@parispittman](https://github.com/parispittman)**) |
46+
| [SIG Testing](sig-testing/README.md) | Paris Pittman (**[@parispittman](https://github.com/parispittman)**) |
47+
| [SIG UI](sig-ui/README.md) | Nikhita Raghunath (**[@nikhita](https://github.com/nikhita)**) |
48+
| [SIG Usability](sig-usability/README.md) | Davanum Srinivas (**[@dims](https://github.com/dims)**) |
49+
| [SIG Windows](sig-windows/README.md) | Jordan Liggitt (**[@liggitt](https://github.com/liggitt)**) |
50+
| [WG API Expression](wg-api-expression/README.md) | Jordan Liggitt (**[@liggitt](https://github.com/liggitt)**) |
51+
| [WG Component Standard](wg-component-standard/README.md) | Christoph Blecker (**[@cblecker](https://github.com/cblecker)**) |
52+
| [WG Data Protection](wg-data-protection/README.md) | Paris Pittman (**[@parispittman](https://github.com/parispittman)**) |
53+
| [WG IoT Edge](wg-iot-edge/README.md) | Derek Carr (**[@derekwaynecarr](https://github.com/derekwaynecarr)**) |
54+
| [WG K8s Infra](wg-k8s-infra/README.md) | Nikhita Raghunath (**[@nikhita](https://github.com/nikhita)**) |
55+
| [WG Multitenancy](wg-multitenancy/README.md) | Jordan Liggitt (**[@liggitt](https://github.com/liggitt)**) |
56+
| [WG Naming](wg-naming/README.md) | Bob Killen (**[@mrbobbytables](https://github.com/mrbobbytables)**) |
57+
| [WG Policy](wg-policy/README.md) | Christoph Blecker (**[@cblecker](https://github.com/cblecker)**) |
58+
| [UG Big Data](ug-big-data/README.md) | Derek Carr (**[@derekwaynecarr](https://github.com/derekwaynecarr)**) |
59+
| [UG VMware Users](ug-vmware-users/README.md) | Nikhita Raghunath (**[@nikhita](https://github.com/nikhita)**) |
60+
<!-- BEGIN CUSTOM CONTENT -->
61+
62+
<!-- END CUSTOM CONTENT -->

sig-api-machinery/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ subprojects, and resolve cross-subproject technical issues and decisions.
4646
- [@kubernetes/sig-api-machinery-pr-reviews](https://github.com/orgs/kubernetes/teams/sig-api-machinery-pr-reviews) - PR Reviews
4747
- [@kubernetes/sig-api-machinery-proposals](https://github.com/orgs/kubernetes/teams/sig-api-machinery-proposals) - Design Proposals
4848
- [@kubernetes/sig-api-machinery-test-failures](https://github.com/orgs/kubernetes/teams/sig-api-machinery-test-failures) - Test Failures and Triage
49+
- Steering Committee Liaison: Davanum Srinivass (**[@dims](https://github.com/dims)**)
4950

5051
## Subprojects
5152

sig-apps/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ The Chairs of the SIG run operations and processes governing the SIG.
3939
- [@kubernetes/sig-apps-pr-reviews](https://github.com/orgs/kubernetes/teams/sig-apps-pr-reviews) - PR Reviews
4040
- [@kubernetes/sig-apps-proposals](https://github.com/orgs/kubernetes/teams/sig-apps-proposals) - Design Proposals
4141
- [@kubernetes/sig-apps-test-failures](https://github.com/orgs/kubernetes/teams/sig-apps-test-failures) - Test Failures and Triage
42+
- Steering Committee Liaison: Bob Killen (**[@mrbobbytables](https://github.com/mrbobbytables)**)
4243

4344
## Subprojects
4445

sig-architecture/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ The Chairs of the SIG run operations and processes governing the SIG.
5050
- [@kubernetes/sig-architecture-pr-reviews](https://github.com/orgs/kubernetes/teams/sig-architecture-pr-reviews) - PR Reviews
5151
- [@kubernetes/sig-architecture-proposals](https://github.com/orgs/kubernetes/teams/sig-architecture-proposals) - Design Proposals
5252
- [@kubernetes/sig-architecture-test-failures](https://github.com/orgs/kubernetes/teams/sig-architecture-test-failures) - Test Failures and Triage
53+
- Steering Committee Liaison: Jordan Liggitt (**[@liggitt](https://github.com/liggitt)**)
5354

5455
## Subprojects
5556

0 commit comments

Comments
 (0)