Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for the new YAML label file format #23020

Merged
merged 11 commits into from
Mar 6, 2023
15 changes: 14 additions & 1 deletion docs/content/doc/advanced/customizing-gitea.en-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
To add a custom label set, 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`:
eeyrjmr marked this conversation as resolved.
Show resolved Hide resolved

```
eeyrjmr marked this conversation as resolved.
Show resolved Hide resolved
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 semi-colon delimited file format can be used that follows [label format](https://github.com/go-gitea/gitea/blob/main/options/label/Default) to `$GITEA_CUSTOM/options/label`.
eeyrjmr marked this conversation as resolved.
Show resolved Hide resolved

`#hex-color label name ; label description`

Please review [custom labels configuration](https://docs.gitea.io/en-us/labels/)
eeyrjmr marked this conversation as resolved.
Show resolved Hide resolved

### Licenses

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