This repository has been archived by the owner on Nov 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 24
/
labels.md.tmpl
53 lines (40 loc) · 2.25 KB
/
labels.md.tmpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Open Services Group GitHub Labels
## Table of Contents
- [Intro](#intro)
- [Why these labels?](#why-these-labels)
- [How do I add a new label?](#how-do-i-add-a-new-label)
{{ range $labelData := . -}}
- [Labels that apply to {{ $labelData.Description }}](#labels-that-apply-to-{{ $labelData.Link }})
{{ end }}
## Intro
This file was auto generated by the [label_sync](https://git.k8s.io/test-infra/label_sync/) tool,
based on the [labels.yaml](./labels.yaml) file that it uses to
sync github labels across repos in the [Open Services Group github org](https://github.com/open-services-group)
### Why these labels?
The rule of thumb is that labels are here because they are intended to be produced or consumed by
our automation (primarily prow) across all repos. There are some labels that can only be manually
applied/removed, and where possible we would rather remove them or add automation to allow a
larger set of contributors to apply/remove them.
### How do I add a new label?
- Add automation that consumes/produces the label
- Open a PR, _with a single commit_, that:
- updates [labels.yaml](./labels.yaml) with the new label(s)
- runs `label_sync` (to regenerate the label descriptions and associated CSS)
- After the PR is merged, a prow job is responsible for syncing labels
You can run `label_sync` in a container using:
```sh
podman run --rm -v ./:/community:z \
gcr.io/k8s-prow/label_sync:latest \
--action docs \
--config /community/labels.yaml \
--docs-template /community/labels.md.tmpl \
--docs-output /community/labels.md
```
{{ range $labelData := . -}}
## Labels that apply to {{ $labelData.Description }}
| Name | Description | Added By | Prow Plugin |
| ---- | ----------- | -------- | --- |
{{ range $labelData.Labels -}}
| <a id="{{ anchor .Name }}" href="#{{ anchor .Name }}">`{{ .Name }}`</a> | {{ if .DeleteAfter -}} REMOVING. This will be deleted after {{ .DeleteAfter }} <br><br> {{ end -}} {{ .Description }} {{- if .Previously }} <br><br> This was previously {{ range .Previously -}} `{{.Name }}`, {{ end -}} {{ end -}} | {{.AddedBy }} | {{ if .ProwPlugin }} [{{.ProwPlugin}}](https://git.k8s.io/test-infra/prow/{{ if .IsExternalPlugin }}external-{{ end }}plugins/{{.ProwPlugin}}) {{ end }}|
{{ end }}
{{ end }}