k8s.io/test-infra@v0.0.0-20240520184403-27c6b4c223d8/label_sync/labels.md.tmpl (about)

     1  # Kubernetes GitHub Labels
     2  
     3  ## Table of Contents
     4  
     5  - [Intro](#intro)
     6    - [Why these labels?](#why-these-labels)
     7    - [How do I add a new label?](#how-do-i-add-a-new-label)
     8  {{ range $labelData := . -}}
     9    - [Labels that apply to {{ $labelData.Description }}](#labels-that-apply-to-{{ $labelData.Link }})
    10  {{ end }}
    11  
    12  ## Intro
    13  
    14  This file was auto generated by the [label_sync](https://git.k8s.io/test-infra/label_sync/) tool,
    15  based on the [labels.yaml](https://git.k8s.io/test-infra/label_sync/labels.yaml) that it uses to
    16  sync github labels across repos in the [kubernetes github org](https://github.com/kubernetes)
    17  
    18  ### Why these labels?
    19  
    20  The rule of thumb is that labels are here because they are intended to be produced or consumed by
    21  our automation (primarily prow) across all repos. There are some labels that can only be manually
    22  applied/removed, and where possible we would rather remove them or add automation to allow a 
    23  larger set of contributors to apply/remove them.
    24  
    25  ### How do I add a new label?
    26  
    27  - Add automation that consumes/produces the label
    28  - Open a PR, _with a single commit_, that:
    29    - updates [labels.yaml](https://git.k8s.io/test-infra/label_sync/labels.yaml) with the new label(s)
    30    - runs `make update-labels` from the repo root (to regenerate the label descriptions and associated CSS)
    31  - Involve [sig-contributor-experience](https://git.k8s.io/community/sig-contributor-experience) in the change, eg: chat about it in slack, mention @kubernetes/sig-contributor-experience-pr-reviews in the PR, etc.
    32  - After the PR is merged, a kubernetes CronJob is responsible for syncing labels daily
    33  
    34  
    35  {{ range $labelData := . -}}
    36  ## Labels that apply to {{ $labelData.Description }}
    37  
    38  | Name | Description | Added By | Prow Plugin |
    39  | ---- | ----------- | -------- | --- |
    40  {{ range $labelData.Labels -}}
    41    | <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://github.com/kubernetes-sigs/prow/tree/main/prow/{{ if .IsExternalPlugin }}external-{{ end }}plugins/{{.ProwPlugin}}) {{ end }}|
    42  {{ end }}
    43  {{ end }}