Update documentation for the new YAML label file format (#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: 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>
This commit is contained in:
parent
27ba7fff6d
commit
84a299310d
1 changed files with 14 additions and 1 deletions
|
@ -282,9 +282,22 @@ To add custom .gitignore, add a file with existing [.gitignore rules](https://gi
|
||||||
|
|
||||||
### Labels
|
### 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`
|
`#hex-color label name ; label description`
|
||||||
|
|
||||||
|
For more information, see the [labels documentation]({{< relref "doc/usage/labels.en-us.md" >}}).
|
||||||
|
|
||||||
### Licenses
|
### Licenses
|
||||||
|
|
||||||
To add a custom license, add a file with the license text to `$GITEA_CUSTOM/options/license`
|
To add a custom license, add a file with the license text to `$GITEA_CUSTOM/options/license`
|
||||||
|
|
Loading…
Reference in a new issue