Merge pull request #3437 from nikhita/committee-sigs-yaml

generator: add support for committees
This commit is contained in:
Kubernetes Prow Robot 2019-03-18 13:28:20 -07:00 committed by GitHub
commit 45fd38089c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 373 additions and 33 deletions

2
OWNERS
View File

@ -16,4 +16,4 @@ approvers:
- idvoretskyi
- jdumars
- parispittman
- steering-committee
- committee-steering

View File

@ -158,8 +158,19 @@ aliases:
- joelsmith
- cji
- jaybeale
## BEGIN CUSTOM CONTENT
steering-committee:
committee-code-of-conduct:
- jdumars
- parispittman
- carolynvs
- eparis
- bradamant3
committee-product-security:
- philips
- jessfraz
- cjcullen
- tallclair
- liggitt
committee-steering:
- bgrant0607
- brendanburns
- derekwaynecarr
@ -172,16 +183,6 @@ aliases:
- smarterclayton
- spiffxp
- timothysc
code-of-conduct-committee:
- jdumars
- parispittman
- eparis
- carolynvs
- bradamant3
product-security-committee:
- philips
- jessfraz
- cjcullen
- tallclair
- liggitt
## BEGIN CUSTOM CONTENT
## END CUSTOM CONTENT

View File

@ -1,8 +1,8 @@
# See the OWNERS docs at https://go.k8s.io/owners
reviewers:
- code-of-conduct-committee
- committee-code-of-conduct
approvers:
- code-of-conduct-committee
- committee-code-of-conduct
labels:
- committee/conduct

View File

@ -1,7 +1,40 @@
# Kubernetes Code of Conduct Committee (CoCC)
<!---
This is an autogenerated file!
Please do not edit this file directly, but instead make changes to the
sigs.yaml file in the project root.
To understand how this file is generated, see https://git.k8s.io/community/generator/README.md
--->
# Code of Conduct Committee
The Kubernetes Code of Conduct Committee (CoCC) is the body that is responsible for enforcing and maintaining the Kubernetes Code of Conduct.
## Members
* Jaice Singer Dumars (**[@jdumars](https://github.com/jdumars)**), Google
* Paris Pittman (**[@parispittman](https://github.com/parispittman)**), Google
* Carolyn Van Slyck (**[@carolynvs](https://github.com/carolynvs)**), Microsoft
* Eric Paris (**[@eparis](https://github.com/eparis)**), Red Hat
* Jennifer Rondeau (**[@bradamant3](https://github.com/bradamant3)**), VMware
## Contact
* Private Mailing List: conduct@kubernetes.io
* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/ug%2Fconduct)
## GitHub Teams
The below teams can be mentioned on issues and PRs in order to get attention from the right people.
Note that the links to display team membership will only work if you are a member of the org.
| Team Name | Details | Description |
| --------- |:-------:| ----------- |
| @kubernetes/code-of-conduct-committee | [link](https://github.com/orgs/kubernetes/teams/code-of-conduct-committee) | General Discussion |
<!-- BEGIN CUSTOM CONTENT -->
## Terms
The members and their terms are as follows:
- Jaice Singer Dumars (Google) - 2 years
- Paris Pittman (Google) - 2 years
@ -12,3 +45,4 @@ The members and their terms are as follows:
Please see the [bootstrapping document](./bootstrapping-process.md) for more information on how members are picked, their responsibilities, and how the committee will initially function.
_More information on how to contact this committee and learn about its process to come in the near future. For now, any Code of Conduct or Code of Conduct Committee concerns can be directed to <conduct@kubernetes.io>_.
<!-- END CUSTOM CONTENT -->

View File

@ -1,8 +1,8 @@
# See the OWNERS docs at https://go.k8s.io/owners
reviewers:
- product-security-committee
- committee-product-security
approvers:
- product-security-committee
- committee-product-security
labels:
- committee/product-security

View File

@ -1,8 +1,40 @@
# Kubernetes Product Security Committee
<!---
This is an autogenerated file!
Please do not edit this file directly, but instead make changes to the
sigs.yaml file in the project root.
To understand how this file is generated, see https://git.k8s.io/community/generator/README.md
--->
# Product Security Committee
The Kubernetes Product Security Committee is the body that is responsible for receiving and responding to reports of security issues in Kubernetes products.
Current committee members are listed on the [Product Security Committee section](https://git.k8s.io/security/security-release-process.md#product-security-committee-psc) of the committee's documentation.
Information on how members are selected is in the [Product Security Committee Membership section](https://git.k8s.io/security/security-release-process.md#product-security-committee-membership) of the same document.
## Members
* Brandon Philips (**[@philips](https://github.com/philips)**), Red Hat
* Jess Frazelle (**[@jessfraz](https://github.com/jessfraz)**)
* CJ Cullen (**[@cjcullen](https://github.com/cjcullen)**), Google
* Tim Allclair (**[@tallclair](https://github.com/tallclair)**), Google
* Jordan Liggitt (**[@liggitt](https://github.com/liggitt)**), Google
## Contact
* Private Mailing List: security@kubernetes.io
* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/ug%2Fproduct-security)
## GitHub Teams
The below teams can be mentioned on issues and PRs in order to get attention from the right people.
Note that the links to display team membership will only work if you are a member of the org.
| Team Name | Details | Description |
| --------- |:-------:| ----------- |
| @kubernetes/product-security-committee | [link](https://github.com/orgs/kubernetes/teams/product-security-committee) | General Discussion |
<!-- BEGIN CUSTOM CONTENT -->
**Note**: Information on how members are selected can be found
[here](https://git.k8s.io/security/security-release-process.md#product-security-committee-membership).
_To report a security issue, please email the private security@kubernetes.io list with the security details and the details expected for all Kubernetes bug reports._
<!-- END CUSTOM CONTENT -->

View File

@ -1,8 +1,8 @@
# See the OWNERS docs at https://go.k8s.io/owners
reviewers:
- steering-committee
- committee-steering
approvers:
- steering-committee
- committee-steering
labels:
- committee/steering

View File

@ -0,0 +1,50 @@
<!---
This is an autogenerated file!
Please do not edit this file directly, but instead make changes to the
sigs.yaml file in the project root.
To understand how this file is generated, see https://git.k8s.io/community/generator/README.md
--->
# Steering Committee
The Kubernetes Steering Committee is the governing body of the Kubernetes project, providing decision-making and oversight pertaining to the Kubernetes project bylaws, sub-organizations, and financial planning. The Steering Committee also defines the project values and structure.
The [charter](https://git.k8s.io/steering/charter.md) defines the scope and governance of the Steering Committee.
## Meetings
* Public Steering Committee Meeting: [Wednesdays at 13:00 PT (Pacific Time)](https://bit.ly/k8s-steering-wd) (biweekly). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=13:00&tz=PT%20%28Pacific%20Time%29).
* [Meeting recordings](https://www.youtube.com/watch?v=YAzgJRQxsdc&list=PL69nYSiGNLP1yP1B_nd9-drjoxp0Q14qM).
## Members
* Brian Grant (**[@bgrant0607](https://github.com/bgrant0607)**), Google
* Brendan Burns (**[@brendanburns](https://github.com/brendanburns)**), Microsoft
* Derek Carr (**[@derekwaynecarr](https://github.com/derekwaynecarr)**), Red Hat
* Davanum Srinivas (**[@dims](https://github.com/dims)**), Huawei
* Joe Beda (**[@jbeda](https://github.com/jbeda)**), VMware
* Michelle Noorali (**[@michelleN](https://github.com/michelleN)**), Microsoft
* Brandon Philips (**[@philips](https://github.com/philips)**), Red Hat
* Phillip Wittrock (**[@pwittrock](https://github.com/pwittrock)**), Google
* Sarah Novotny (**[@sarahnovotny](https://github.com/sarahnovotny)**), Google
* Clayton Coleman (**[@smarterclayton](https://github.com/smarterclayton)**), Red Hat
* Aaron Crickenberger (**[@spiffxp](https://github.com/spiffxp)**), Google
* Timothy St. Clair (**[@timothysc](https://github.com/timothysc)**), VMware
## Contact
* [Mailing list](https://groups.google.com/a/kubernetes.io/forum/#!forum/steering)
* Private Mailing List: steering-private@kubernetes.io
* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/ug%2Fsteering)
## GitHub Teams
The below teams can be mentioned on issues and PRs in order to get attention from the right people.
Note that the links to display team membership will only work if you are a member of the org.
| Team Name | Details | Description |
| --------- |:-------:| ----------- |
| @kubernetes/steering-committee | [link](https://github.com/orgs/kubernetes/teams/steering-committee) | General Discussion |
<!-- BEGIN CUSTOM CONTENT -->
<!-- END CUSTOM CONTENT -->

View File

@ -1,7 +1,8 @@
# SIG Doc builder
This folder contains scripts to automatically generate documentation about the
different Special Interest Groups (SIGs) and Working Groups (WGs) of Kubernetes. The authoritative
different Special Interest Groups (SIGs), Working Groups (WGs),
User Groups (UGs) and Committees of Kubernetes. The authoritative
source for SIG information is the [`sigs.yaml`](/sigs.yaml) file in the project root.
All updates must be done there.
@ -14,6 +15,7 @@ The documentation follows a template and uses the values from [`sigs.yaml`](/sig
- SIG README: [`sig_readme.tmpl`](sig_readme.tmpl)
- WG README: [`wg_readme.tmpl`](wg_readme.tmpl)
- UG README: [`ug_readme.tmpl`](ug_readme.tmpl)
- Committee README: [`committee_readme.tmpl`](committee_readme.tmpl)
**Time Zone gotcha**:
Time zones make everything complicated.
@ -24,12 +26,13 @@ Practically, that means US pacific time must be `PT (Pacific Time)`.
`PT` isn't good enough, unfortunately.
When an update happens to the this file, the next step is to generate the
accompanying documentation. This takes the format of three types of doc files:
accompanying documentation. This takes the format of the following types of doc files:
```
sig-<sig-name>/README.md
wg-<working-group-name>/README.md
ug-<user-group-name>/README.md
committee-<committee-name>/README.md
sig-list.md
```
@ -64,9 +67,11 @@ make WHAT=container-identity
where the `WHAT` var refers to the directory being built.
## Adding custom content to your README
## Adding custom content
If your SIG or WG wishes to add custom content, you can do so by placing it within
### README
If your SIG, WG, UG or Committee wishes to add custom content, you can do so by placing it within
the following code comments:
```markdown
@ -88,3 +93,14 @@ An example might be:
- Do that
<!-- END CUSTOM CONTENT -->
```
### OWNERS_ALIASES
Similarly, custom aliases can be added in the `OWNERS_ALIASES` file by placing
it within the following code comments:
```yaml
## BEGIN CUSTOM CONTENT
## END CUSTOM CONTENT
```

View File

@ -20,3 +20,9 @@ aliases:
- {{.GitHub}}
{{- end}}
{{- end}}
{{- range .Committees}}
{{.Dir}}:
{{- range .Leadership.Chairs}}
- {{.GitHub}}
{{- end}}
{{- end}}

View File

@ -75,6 +75,7 @@ type Meeting struct {
type Contact struct {
Slack string
MailingList string `yaml:"mailing_list"`
PrivateMailingList string `yaml:"private_mailing_list"`
GithubTeams []GithubTeams `yaml:"teams"`
}
@ -125,6 +126,7 @@ type Context struct {
Sigs []Group
WorkingGroups []Group
UserGroups []Group
Committees []Group
}
func pathExists(path string) bool {
@ -310,6 +312,10 @@ func main() {
return strings.ToLower(ctx.UserGroups[i].Name) <= strings.ToLower(ctx.UserGroups[j].Name)
})
sort.Slice(ctx.Committees, func(i, j int) bool {
return strings.ToLower(ctx.Committees[i].Name) <= strings.ToLower(ctx.Committees[j].Name)
})
err = createGroupReadme(ctx.Sigs, "sig")
if err != nil {
log.Fatal(err)
@ -325,6 +331,11 @@ func main() {
log.Fatal(err)
}
err = createGroupReadme(ctx.Committees, "committee")
if err != nil {
log.Fatal(err)
}
fmt.Println("Generating sig-list.md")
outputPath := filepath.Join(baseGeneratorDir, sigListOutput)
err = writeTemplate(filepath.Join(baseGeneratorDir, templateDir, listTemplate), outputPath, "markdown", ctx)

View File

@ -0,0 +1,57 @@
{{- template "header" }}
# {{.Name}} Committee
{{ .MissionStatement }}
{{- if .CharterLink }}
The [charter]({{.CharterLink}}) defines the scope and governance of the {{.Name}} Committee.
{{- end }}
{{- if .Meetings }}
## Meetings
{{- range .Meetings }}
* {{.Description}}: [{{.Day}}s at {{.Time}} {{.TZ}}]({{.URL}}) ({{.Frequency}}). [Convert to your timezone](http://www.thetimezoneconverter.com/?t={{.Time}}&tz={{.TZ | tzUrlEncode}}).
{{- if .ArchiveURL }}
* [Meeting notes and Agenda]({{.ArchiveURL}}).
{{- end }}
{{- if .RecordingsURL }}
* [Meeting recordings]({{.RecordingsURL}}).
{{- end }}
{{- end }}
{{- end }}
{{- if .Leadership }}
{{- if .Leadership.Chairs }}
## Members
{{ range .Leadership.Chairs }}
* {{.Name}} (**[@{{.GitHub}}](https://github.com/{{.GitHub}})**){{if .Company}}, {{.Company}}{{end}}
{{- end }}
{{- end }}
{{- end }}
## Contact
{{- if .Contact.Slack }}
* [Slack](https://kubernetes.slack.com/messages/{{.Contact.Slack}})
{{- end }}
{{- if .Contact.MailingList }}
* [Mailing list]({{.Contact.MailingList}})
{{- end }}
{{- if .Contact.PrivateMailingList }}
* Private Mailing List: {{.Contact.PrivateMailingList}}
{{- end }}
{{- if .Label }}
* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/ug%2F{{.Label}})
{{- end }}
{{ if .Contact.GithubTeams }}
## GitHub Teams
The below teams can be mentioned on issues and PRs in order to get attention from the right people.
Note that the links to display team membership will only work if you are a member of the org.
| Team Name | Details | Description |
| --------- |:-------:| ----------- |
{{- range .Contact.GithubTeams }}
| @kubernetes/{{.Name}} | [link](https://github.com/orgs/kubernetes/teams/{{.Name}}) | {{.Description}} |
{{- end }}
{{ end }}

View File

@ -44,3 +44,10 @@ When the need arises, a [new SIG can be created](sig-wg-lifecycle.md)
|[{{.Name}}]({{.Dir}}/README.md)|{{range .Leadership.Chairs}}* [{{.Name}}](https://github.com/{{.GitHub}}){{if .Company}}, {{.Company}}{{end}}<br>{{end}}|* [Slack](https://kubernetes.slack.com/messages/{{.Contact.Slack}})<br>* [Mailing List]({{.Contact.MailingList}})|{{range .Meetings}}* {{.Description}}: [{{.Day}}s at {{.Time}} {{.TZ}} ({{.Frequency}})]({{.URL}})<br>{{end}}
{{- end }}
{{ end }}
### Master Committee List
| Name | Label | Members | Contact |
|------|--------|---------|---------|
{{- range .Committees}}
|[{{.Name}}]({{.Dir}}/README.md)|{{.Label}}|{{range .Leadership.Chairs}}* [{{.Name}}](https://github.com/{{.GitHub}}){{if .Company}}, {{.Company}}{{end}}<br>{{end}}|{{ if .Contact.Slack }}* [Slack](https://kubernetes.slack.com/messages/{{.Contact.Slack}})<br>{{ end }}{{ if .Contact.MailingList }}* [Mailing List]({{.Contact.MailingList}})<br>{{ end }}{{ if .Contact.PrivateMailingList }}* [Private Mailing List]({{.Contact.PrivateMailingList}}){{ end }}
{{- end }}

View File

@ -37,7 +37,7 @@ make 1>/dev/null
mismatches=0
break=$(printf "=%.0s" $(seq 1 68))
for file in $(ls ${CRT_DIR}/sig-*/README.md ${CRT_DIR}/wg-*/README.md ${CRT_DIR}/ug-*/README.md ${CRT_DIR}/sig-list.md ${CRT_DIR}/OWNERS_ALIASES); do
for file in $(ls ${CRT_DIR}/sig-*/README.md ${CRT_DIR}/wg-*/README.md ${CRT_DIR}/ug-*/README.md ${CRT_DIR}/committee-*/README.md ${CRT_DIR}/sig-list.md ${CRT_DIR}/OWNERS_ALIASES); do
real=${file#$CRT_DIR/}
if ! diff -q ${file} ${WORKING_DIR}/${real} &>/dev/null; then
echo "${file} does not match ${WORKING_DIR}/${real}";

View File

@ -68,6 +68,13 @@ When the need arises, a [new SIG can be created](sig-wg-lifecycle.md)
|[Resource Management](wg-resource-management/README.md)||* [Vishnu Kannan](https://github.com/vishh), Google<br>* [Derek Carr](https://github.com/derekwaynecarr), Red Hat<br>|* [Slack](https://kubernetes.slack.com/messages/wg-resource-mgmt)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-wg-resource-management)|* Regular WG Meeting: [Wednesdays at 11:00 PT (Pacific Time) (biweekly (On demand))](https://docs.google.com/document/d/1FQx0BPlkkl1Bn0c9ocVBxYIKojpmrS1CFP5h0DI68AE/edit)<br>
|[Security Audit](wg-security-audit/README.md)||* [Aaron Small](https://github.com/aasmall), Google<br>* [Joel Smith](https://github.com/joelsmith), Red Hat<br>* [Craig Ingram](https://github.com/cji), Salesforce<br>* [Jay Beale](https://github.com/jaybeale), InGuardians<br>|* [Slack](https://kubernetes.slack.com/messages/wg-security-audit)<br>* [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-wg-security-audit)|* Regular WG Meeting: [Mondays at 13:00 PT (Pacific Time) (weekly)](https://docs.google.com/document/d/1RbC4SBZBlKth7IjYv_NaEpnmLGwMJ0ElpUOmsG-bdRA/edit)<br>
### Master Committee List
| Name | Label | Members | Contact |
|------|--------|---------|---------|
|[Code of Conduct](committee-code-of-conduct/README.md)|conduct|* [Jaice Singer Dumars](https://github.com/jdumars), Google<br>* [Paris Pittman](https://github.com/parispittman), Google<br>* [Carolyn Van Slyck](https://github.com/carolynvs), Microsoft<br>* [Eric Paris](https://github.com/eparis), Red Hat<br>* [Jennifer Rondeau](https://github.com/bradamant3), VMware<br>|* [Private Mailing List](conduct@kubernetes.io)
|[Product Security](committee-product-security/README.md)|product-security|* [Brandon Philips](https://github.com/philips), Red Hat<br>* [Jess Frazelle](https://github.com/jessfraz)<br>* [CJ Cullen](https://github.com/cjcullen), Google<br>* [Tim Allclair](https://github.com/tallclair), Google<br>* [Jordan Liggitt](https://github.com/liggitt), Google<br>|* [Private Mailing List](security@kubernetes.io)
|[Steering](committee-steering/README.md)|steering|* [Brian Grant](https://github.com/bgrant0607), Google<br>* [Brendan Burns](https://github.com/brendanburns), Microsoft<br>* [Derek Carr](https://github.com/derekwaynecarr), Red Hat<br>* [Davanum Srinivas](https://github.com/dims), Huawei<br>* [Joe Beda](https://github.com/jbeda), VMware<br>* [Michelle Noorali](https://github.com/michelleN), Microsoft<br>* [Brandon Philips](https://github.com/philips), Red Hat<br>* [Phillip Wittrock](https://github.com/pwittrock), Google<br>* [Sarah Novotny](https://github.com/sarahnovotny), Google<br>* [Clayton Coleman](https://github.com/smarterclayton), Red Hat<br>* [Aaron Crickenberger](https://github.com/spiffxp), Google<br>* [Timothy St. Clair](https://github.com/timothysc), VMware<br>|* [Mailing List](https://groups.google.com/a/kubernetes.io/forum/#!forum/steering)<br>* [Private Mailing List](steering-private@kubernetes.io)
<!-- BEGIN CUSTOM CONTENT -->
<!-- END CUSTOM CONTENT -->

119
sigs.yaml
View File

@ -2502,3 +2502,122 @@ workinggroups:
contact:
slack: wg-k8s-infra
mailing_list: https://groups.google.com/forum/#!forum/kubernetes-wg-k8s-infra
committees:
- name: Steering
dir: committee-steering
mission_statement: >
The Kubernetes Steering Committee is the governing body of the Kubernetes
project, providing decision-making and oversight pertaining to the
Kubernetes project bylaws, sub-organizations, and financial planning.
The Steering Committee also defines the project values and structure.
label: steering
charter_link: https://git.k8s.io/steering/charter.md
leadership:
chairs:
- name: Brian Grant
github: bgrant0607
company: Google
- name: Brendan Burns
github: brendanburns
company: Microsoft
- name: Derek Carr
github: derekwaynecarr
company: Red Hat
- name: Davanum Srinivas
github: dims
company: Huawei
- name: Joe Beda
github: jbeda
company: VMware
- name: Michelle Noorali
github: michelleN
company: Microsoft
- name: Brandon Philips
github: philips
company: Red Hat
- name: Phillip Wittrock
github: pwittrock
company: Google
- name: Sarah Novotny
github: sarahnovotny
company: Google
- name: Clayton Coleman
github: smarterclayton
company: Red Hat
- name: Aaron Crickenberger
github: spiffxp
company: Google
- name: Timothy St. Clair
github: timothysc
company: VMware
meetings:
- description: Public Steering Committee Meeting
day: Wednesday
time: "13:00"
tz: "PT (Pacific Time)"
frequency: biweekly
url: https://bit.ly/k8s-steering-wd
recordings_url: https://www.youtube.com/watch?v=YAzgJRQxsdc&list=PL69nYSiGNLP1yP1B_nd9-drjoxp0Q14qM
contact:
mailing_list: https://groups.google.com/a/kubernetes.io/forum/#!forum/steering
private_mailing_list: steering-private@kubernetes.io
teams:
- name: steering-committee
description: General Discussion
- name: Code of Conduct
dir: committee-code-of-conduct
mission_statement: >
The Kubernetes Code of Conduct Committee (CoCC) is the body that is
responsible for enforcing and maintaining the Kubernetes Code of Conduct.
label: conduct
charter_link:
leadership:
chairs:
- name: Jaice Singer Dumars
github: jdumars
company: Google
- name: Paris Pittman
github: parispittman
company: Google
- name: Carolyn Van Slyck
github: carolynvs
company: Microsoft
- name: Eric Paris
github: eparis
company: Red Hat
- name: Jennifer Rondeau
github: bradamant3
company: VMware
contact:
private_mailing_list: conduct@kubernetes.io
teams:
- name: code-of-conduct-committee
description: General Discussion
- name: Product Security
dir: committee-product-security
mission_statement: >
The Kubernetes Product Security Committee is the body that is responsible
for receiving and responding to reports of security issues in Kubernetes
products.
label: product-security
leadership:
chairs:
- name: Brandon Philips
github: philips
company: Red Hat
- name: Jess Frazelle
github: jessfraz
- name: CJ Cullen
github: cjcullen
company: Google
- name: Tim Allclair
github: tallclair
company: Google
- name: Jordan Liggitt
github: liggitt
company: Google
contact:
private_mailing_list: security@kubernetes.io
teams:
- name: product-security-committee
description: General Discussion