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

Add basic documentation for labels, including scoped labels #23304

Merged
merged 4 commits into from
Mar 5, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/content/doc/usage/labels.en-us.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
date: "2023-03-04T19:00:00+00:00"
title: "Usage: Labels"
slug: "labels"
weight: 13
toc: false
draft: false
menu:
sidebar:
parent: "usage"
name: "Labels"
weight: 13
identifier: "labels"
---

# Labels

Issues and pull requests can be assigned labels for organization.
brechtvl marked this conversation as resolved.
Show resolved Hide resolved

## Creating Labels

Labels can be created for a repository by going to Issues and choosing Labels. For organizations, labels available to all repositories can be created in the organization Settings.
brechtvl marked this conversation as resolved.
Show resolved Hide resolved

Labels have a name, color and optional description.
brechtvl marked this conversation as resolved.
Show resolved Hide resolved

If no labels exist a [default label set](../customizing-gitea/#labels) is suggested.
brechtvl marked this conversation as resolved.
Show resolved Hide resolved

## Scoped Labels

Labels can be grouped using scopes indicated with a `/` separator in the name. When a label is named for example `scope/item`, the label display will changed to show the scope and item separately.
brechtvl marked this conversation as resolved.
Show resolved Hide resolved

Mutually exclusive labels can be created by enabling the Exclusive option for scoped labels. This makes it so only one label in the same scope can be assigned to an issue or pull request.
brechtvl marked this conversation as resolved.
Show resolved Hide resolved

## 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.
delvh marked this conversation as resolved.
Show resolved Hide resolved