Skip to content

Commit 84a2993

Browse files
eeyrjmryardenshohamlafriksjolheiserdelvh
authored
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 <[email protected]> --------- Co-authored-by: Yarden Shoham <[email protected]> Co-authored-by: Lauris BH <[email protected]> Co-authored-by: John Olheiser <[email protected]> Co-authored-by: delvh <[email protected]>
1 parent 27ba7ff commit 84a2993

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/content/doc/advanced/customizing-gitea.en-us.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -282,9 +282,22 @@ To add custom .gitignore, add a file with existing [.gitignore rules](https://gi
282282

283283
### Labels
284284

285-
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`
285+
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`:
286+
287+
```yaml
288+
labels:
289+
- name: "foo/bar" # name of the label that will appear in the dropdown
290+
exclusive: true # whether to use the exclusive namespace for scoped labels. scoped delimiter is /
291+
color: aabbcc # hex colour coding
292+
description: Some label # long description of label intent
293+
```
294+
295+
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.
296+
286297
`#hex-color label name ; label description`
287298

299+
For more information, see the [labels documentation]({{< relref "doc/usage/labels.en-us.md" >}}).
300+
288301
### Licenses
289302

290303
To add a custom license, add a file with the license text to `$GITEA_CUSTOM/options/license`

0 commit comments

Comments
 (0)