0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-21 17:36:59 -05:00
forgejo-docs/docs/user/labels.md

58 lines
2.9 KiB
Markdown
Raw Normal View History

2023-03-06 04:34:02 -05:00
---
title: 'Labels'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/labels.en-us.md'
2023-03-06 04:34:02 -05:00
---
You can use labels to classify issues and pull requests and to improve your overview over them.
2023-10-23 06:18:12 -04:00
Labels can be created by going to the `Issues` page of a repository and clicking on `Labels` to show the labels management page.
2023-03-06 04:34:02 -05:00
2023-10-23 06:18:12 -04:00
![repository labels management](../_images/user/labels/repository-labels-management.png)
2023-03-06 04:34:02 -05:00
For organizations, you can define organization-wide labels that are shared with all organization repositories, including both already-existing repositories as well as newly created ones. Organization-wide labels can be created in the organization `Settings`.
2023-10-23 06:18:12 -04:00
![organization labels management](../_images/user/labels/organization-labels-management.png)
2023-03-06 04:34:02 -05:00
2023-10-23 06:18:12 -04:00
## Creating Labels
2023-03-06 04:34:02 -05:00
2023-10-23 06:18:12 -04:00
From the labels management page, click on the `New Label` button.
![create a label](../_images/user/labels/label-new.png)
Labels have a mandatory name, a mandatory color, an optional description, and must either be exclusive or not (see `Scoped labels` below).
2023-03-06 04:34:02 -05:00
2023-10-23 06:18:12 -04:00
When you create a repository (or an organization), you can ensure certain labels exist by using the `Issue Labels` option. This option lists a number of available label sets that are configured globally on your instance.
## Archiving Labels
When a label is no longer useful but needs to be kept around because
2024-07-31 18:47:28 -04:00
it is still associated with existing pull requests or issues, it can be archived.
- The label won't show up as a suggestion when you're adding/editing labels.
- The label cannot be assigned to a new issues or pull requests.
2024-07-31 18:47:28 -04:00
To archive a label, edit the label and click the `Archive` checkbox.
![archive a label](../_images/user/labels/label-archive.png)
2023-03-06 04:34:02 -05:00
## Scoped Labels
Scoped labels are used to ensure at most a single label with the same scope is assigned to an issue or pull request. For example, if labels `kind/bug` and `kind/enhancement` have the Exclusive option set, an issue can only be classified as a bug or an enhancement.
2023-03-06 04:34:02 -05:00
![list of labels](../_images/user/labels/label-list.png)
2023-03-06 04:34:02 -05:00
A scoped label must contain `/` in its name (not at either end of the name). The scope of a label is determined based on the **last** `/`, so for example the scope of label `scope/subscope/item` is `scope/subscope`.
2023-03-06 04:34:02 -05:00
2024-07-31 18:47:28 -04:00
## Applying labels
Labels can be applied to issues or pull requests on their pages by clicking on `Labels`. In the dropdown menu, labels can be added or removed. Of a set of scoped labels with the same scope, only one can be selected. Archived labels are disabled for addition.
![apply labels](../_images/user/labels/label-apply.png)
2023-03-06 04:34:02 -05:00
## Filtering by Label
Issue and pull request lists can be filtered by label. Selecting multiple labels shows issues and pull requests that have all selected labels assigned.
By holding alt to click the label, issues and pull requests with the chosen label are excluded from the list.