diff options
| author | Giteabot <teabot@gitea.io> | 2023-03-06 18:52:29 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-06 17:52:29 -0600 |
| commit | 61f91bdc7e0ed3bd286d269faad56756f5b97c6d (patch) | |
| tree | aedd535a93dacf34f4910a180a938aa4c14685a2 /docs/content/doc/advanced/customizing-gitea.en-us.md | |
| parent | 8ab50be000f47d25c43db71594af3fe9a7ff1287 (diff) | |
| download | gitea-61f91bdc7e0ed3bd286d269faad56756f5b97c6d.tar.gz gitea-61f91bdc7e0ed3bd286d269faad56756f5b97c6d.zip | |
Update documentation for the new YAML label file format (#23020) (#23341)
Backport #23020
update documentation to include an overview of the yaml label template
that is part of PR #22976
Signed-off-by: Jon Roadley-Battin <jon.roadleybattin@gmail.com>
Co-authored-by: JonRB <4564448+eeyrjmr@users.noreply.github.com>
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lauris BH <lauris@nix.lv>
Co-authored-by: John Olheiser <john.olheiser@gmail.com>
Co-authored-by: delvh <dev.lh@web.de>
Diffstat (limited to 'docs/content/doc/advanced/customizing-gitea.en-us.md')
| -rw-r--r-- | docs/content/doc/advanced/customizing-gitea.en-us.md | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/content/doc/advanced/customizing-gitea.en-us.md b/docs/content/doc/advanced/customizing-gitea.en-us.md index 18fc1b3e73..bad6342aad 100644 --- a/docs/content/doc/advanced/customizing-gitea.en-us.md +++ b/docs/content/doc/advanced/customizing-gitea.en-us.md @@ -282,9 +282,22 @@ To add custom .gitignore, add a file with existing [.gitignore rules](https://gi ### Labels -To add a custom label set, add a file that follows the [label format](https://github.com/go-gitea/gitea/blob/main/options/label/Default) to `$GITEA_CUSTOM/options/label` +Starting with Gitea 1.19, you can add a file that follows the [YAML label format](https://github.com/go-gitea/gitea/blob/main/options/label/Advanced.yaml) to `$GITEA_CUSTOM/options/label`: + +```yaml +labels: + - name: "foo/bar" # name of the label that will appear in the dropdown + exclusive: true # whether to use the exclusive namespace for scoped labels. scoped delimiter is / + color: aabbcc # hex colour coding + description: Some label # long description of label intent + ``` + +The [legacy file format](https://github.com/go-gitea/gitea/blob/main/options/label/Default) can still be used following the format below, however we strongly recommend using the newer YAML format instead. + `#hex-color label name ; label description` +For more information, see the [labels documentation]({{< relref "doc/usage/labels.en-us.md" >}}). + ### Licenses To add a custom license, add a file with the license text to `$GITEA_CUSTOM/options/license` |