debian-mirror-gitlab/doc/user/project/issue_board.md

641 lines
28 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
stage: Plan
group: Project Management
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-06-23 00:09:42 +05:30
---
2021-11-11 11:23:49 +05:30
# Issue boards **(FREE)**
2016-09-13 17:45:13 +05:30
2021-11-11 11:23:49 +05:30
The issue board is a software project management tool used to plan,
2016-09-13 17:45:13 +05:30
organize, and visualize a workflow for a feature or product release.
2020-04-22 19:07:51 +05:30
It can be used as a [Kanban](https://en.wikipedia.org/wiki/Kanban_(development)) or a
[Scrum](https://en.wikipedia.org/wiki/Scrum_(software_development)) board.
2016-09-13 17:45:13 +05:30
2021-01-03 14:25:43 +05:30
It pairs issue tracking and project management, keeping everything together,
2020-11-24 15:15:51 +05:30
so that you don't need to jump between different platforms to organize your workflow.
2018-03-17 18:26:18 +05:30
2021-04-29 21:17:54 +05:30
Issue boards build on the existing [issue tracking functionality](issues/index.md) and
2020-11-24 15:15:51 +05:30
[labels](labels.md). Your issues appear as cards in vertical lists, organized by their assigned
labels, [milestones](#milestone-lists), or [assignees](#assignee-lists).
2018-12-05 23:21:45 +05:30
2020-11-24 15:15:51 +05:30
Issue boards help you to visualize and manage your entire process in GitLab.
You add your labels, and then create the corresponding list for your existing issues.
When you're ready, you can drag your issue cards from one step to another one.
2018-12-05 23:21:45 +05:30
2021-01-03 14:25:43 +05:30
An issue board can show you the issues your team is working on, who is assigned to each,
and where the issues are in the workflow.
2018-12-05 23:21:45 +05:30
2020-11-24 15:15:51 +05:30
To let your team members organize their own workflows, use
[multiple issue boards](#use-cases-for-multiple-issue-boards). This allows creating multiple issue
boards in the same project.
2020-05-24 23:13:21 +05:30
2021-10-27 15:23:28 +05:30
![GitLab issue board - Core](img/issue_boards_core_v14_1.png)
2016-09-13 17:45:13 +05:30
2020-11-24 15:15:51 +05:30
Different issue board features are available in different [GitLab tiers](https://about.gitlab.com/pricing/),
as shown in the following table:
2016-09-13 17:45:13 +05:30
2021-09-04 01:27:46 +05:30
| Tier | Number of project issue boards | Number of [group issue boards](#group-issue-boards) | [Configurable issue boards](#configurable-issue-boards) | [Assignee lists](#assignee-lists) |
| -------- | ------------------------------ | --------------------------------------------------- | ------------------------------------------------------- | --------------------------------- |
| Free | Multiple | 1 | No | No |
| Premium | Multiple | Multiple | Yes | Yes |
| Ultimate | Multiple | Multiple | Yes | Yes |
2017-09-10 17:25:29 +05:30
2020-11-24 15:15:51 +05:30
To learn more, visit [GitLab Enterprise features for issue boards](#gitlab-enterprise-features-for-issue-boards) below.
2017-09-10 17:25:29 +05:30
2021-10-27 15:23:28 +05:30
![GitLab issue board - Premium](img/issue_boards_premium_v14_1.png)
2017-09-10 17:25:29 +05:30
2020-11-24 15:15:51 +05:30
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
Watch a [video presentation](https://youtu.be/vjccjHI7aGI) of
2021-11-11 11:23:49 +05:30
the issue board feature.
2017-09-10 17:25:29 +05:30
2021-02-22 17:27:13 +05:30
## Multiple issue boards
2021-03-11 19:13:27 +05:30
> - Multiple issue boards per project [moved](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/53811) to GitLab Free in 12.1.
> - Multiple issue boards per group are available in GitLab Premium.
2021-02-22 17:27:13 +05:30
2021-03-11 19:13:27 +05:30
Multiple issue boards allow for more than one issue board for a given project **(FREE)** or group **(PREMIUM)**.
2021-02-22 17:27:13 +05:30
This is great for large projects with more than one team or when a repository hosts the code of multiple products.
Using the search box at the top of the menu, you can filter the listed boards.
When you have ten or more boards available, a **Recent** section is also shown in the menu, with
shortcuts to your last four visited boards.
![Multiple issue boards](img/issue_boards_multiple_v13_6.png)
When you're revisiting an issue board in a project or group with multiple boards,
GitLab automatically loads the last board you visited.
### Create an issue board
To create a new issue board:
2021-11-11 11:23:49 +05:30
1. Click the dropdown with the current board name in the upper left corner of the issue boards page.
2021-02-22 17:27:13 +05:30
1. Click **Create new board**.
1. Enter the new board's name and select its scope: milestone, labels, assignee, or weight.
### Delete an issue board
To delete the currently active issue board:
2021-11-11 11:23:49 +05:30
1. Click the dropdown with the current board name in the upper left corner of the issue boards page.
2021-02-22 17:27:13 +05:30
1. Click **Delete board**.
1. Click **Delete** to confirm.
2020-11-24 15:15:51 +05:30
## Issue boards use cases
2017-09-10 17:25:29 +05:30
2020-10-24 23:57:45 +05:30
You can tailor GitLab issue boards to your own preferred workflow.
2020-05-24 23:13:21 +05:30
Here are some common use cases for issue boards.
2018-11-08 19:23:39 +05:30
2021-04-17 20:07:23 +05:30
For examples of using issue boards along with [epics](../group/epics/index.md),
2021-04-29 21:17:54 +05:30
[issue health status](issues/managing_issues.md#health-status), and
2021-04-17 20:07:23 +05:30
[scoped labels](labels.md#scoped-labels) for various Agile frameworks, check:
2021-02-22 17:27:13 +05:30
- The [How to use GitLab for Agile portfolio planning and project management](https://about.gitlab.com/blog/2020/11/11/gitlab-for-agile-portfolio-planning-project-management/) blog post (November 2020)
- <i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
[Cross-project Agile work management with GitLab](https://www.youtube.com/watch?v=5J0bonGoECs) (15 min, July 2020)
2020-05-24 23:13:21 +05:30
### Use cases for a single issue board
2018-11-08 19:23:39 +05:30
2021-09-30 23:02:18 +05:30
With the [GitLab Flow](https://about.gitlab.com/topics/version-control/what-is-gitlab-flow/) you can
discuss proposals in issues, label them, and organize and prioritize them with issue boards.
2017-09-10 17:25:29 +05:30
For example, let's consider this simplified development workflow:
2020-05-24 23:13:21 +05:30
1. You have a repository that hosts your application's codebase, and your team actively contributes code.
1. Your **backend** team starts working on a new implementation, gathers feedback and approval, and
passes it over to the **frontend** team.
1. When frontend is complete, the new feature is deployed to a **staging** environment to be tested.
1. When successful, it's deployed to **production**.
2017-09-10 17:25:29 +05:30
2021-01-29 00:20:46 +05:30
If you have the labels **Backend**, **Frontend**, **Staging**, and
**Production**, and an issue board with a list for each, you can:
2017-09-10 17:25:29 +05:30
2020-05-24 23:13:21 +05:30
- Visualize the entire flow of implementations since the beginning of the development life cycle
until deployed to production.
- Prioritize the issues in a list by moving them vertically.
- Move issues between lists to organize them according to the labels you've set.
- Add multiple issues to lists in the board by selecting one or more existing issues.
2017-09-10 17:25:29 +05:30
2021-01-29 00:20:46 +05:30
![issue card moving](img/issue_board_move_issue_card_list_v13_6.png)
2017-09-10 17:25:29 +05:30
2020-05-24 23:13:21 +05:30
### Use cases for multiple issue boards
2018-11-08 19:23:39 +05:30
2020-05-24 23:13:21 +05:30
With [multiple issue boards](#multiple-issue-boards),
2018-11-08 19:23:39 +05:30
each team can have their own board to organize their workflow individually.
#### Scrum team
2020-05-24 23:13:21 +05:30
With multiple issue boards, each team has one board. Now you can move issues through each
2018-11-08 19:23:39 +05:30
part of the process. For instance: **To Do**, **Doing**, and **Done**.
#### Organization of topics
2020-05-24 23:13:21 +05:30
Create lists to order issues by topic and quickly change them between topics or groups,
such as between **UX**, **Frontend**, and **Backend**. The changes are reflected across boards,
as changing lists updates the labels on each issue accordingly.
2018-11-08 19:23:39 +05:30
#### Advanced team handover
2020-05-24 23:13:21 +05:30
For example, suppose we have a UX team with an issue board that contains:
2018-11-08 19:23:39 +05:30
- **To Do**
- **Doing**
- **Frontend**
2020-05-24 23:13:21 +05:30
When finished with something, they move the card to **Frontend**. The Frontend team's board looks like:
2018-11-08 19:23:39 +05:30
- **Frontend**
- **Doing**
- **Done**
2020-05-24 23:13:21 +05:30
Cards finished by the UX team automatically appear in the **Frontend** column when they are ready
for them.
2018-11-08 19:23:39 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2018-11-08 19:23:39 +05:30
For a broader use case, please see the blog post
2021-09-30 23:02:18 +05:30
[What is GitLab Flow?](https://about.gitlab.com/topics/version-control/what-is-gitlab-flow/).
2018-11-08 19:23:39 +05:30
For a real use case example, you can read why
2020-05-24 23:13:21 +05:30
[Codepen decided to adopt issue boards](https://about.gitlab.com/blog/2017/01/27/codepen-welcome-to-gitlab/#project-management-everything-in-one-place)
2018-11-08 19:23:39 +05:30
to improve their workflow with multiple boards.
2017-09-10 17:25:29 +05:30
2018-11-08 19:23:39 +05:30
#### Quick assignments
2016-09-13 17:45:13 +05:30
2021-02-22 17:27:13 +05:30
To quickly assign issues to your team members:
1. Create [assignee lists](#assignee-lists) for each team member.
1. Drag an issue onto the team member's list.
2020-05-24 23:13:21 +05:30
## Issue board terminology
An **issue board** represents a unique view of your issues. It can have multiple lists with each
list consisting of issues represented by cards.
A **list** is a column on the issue board that displays issues matching certain attributes.
In addition to the default "Open" and "Closed" lists, each additional list shows issues matching
your chosen label, assignee, or milestone. On the top of each list you can see the number of issues
that belong to it. Types of lists include:
- **Open** (default): all open issues that do not belong to one of the other lists.
Always appears as the leftmost list.
- **Closed** (default): all closed issues. Always appears as the rightmost list.
- **Label list**: all open issues for a label.
2020-11-24 15:15:51 +05:30
- [**Assignee list**](#assignee-lists): all open issues assigned to a user.
- [**Milestone list**](#milestone-lists): all open issues for a milestone.
2016-09-13 17:45:13 +05:30
2020-05-24 23:13:21 +05:30
A **Card** is a box on a list, and it represents an issue. You can drag cards from one list to
another to change their label, assignee, or milestone. The information you can see on a
card includes:
2016-09-13 17:45:13 +05:30
2020-05-24 23:13:21 +05:30
- Issue title
- Associated labels
- Issue number
- Assignee
2018-11-08 19:23:39 +05:30
2018-12-05 23:21:45 +05:30
## Permissions
2020-05-24 23:13:21 +05:30
Users with the [Reporter and higher roles](../permissions.md) can use all the functionality of the
2021-11-11 11:23:49 +05:30
issue board feature to create or delete lists. They can also drag issues from one list to another.
2018-12-05 23:21:45 +05:30
2021-12-11 22:18:48 +05:30
## Ordering issues in a list
2018-12-05 23:21:45 +05:30
2021-11-18 22:05:49 +05:30
When an issue is created, the system assigns a relative order value that is greater than the maximum value
of that issue's project or root group. This means the issue will be at the bottom of any issue list that
it appears in.
2020-05-24 23:13:21 +05:30
2021-12-11 22:18:48 +05:30
When you visit a board, issues appear ordered in any list. You're able to change
that order by dragging the issues. The changed order is saved, so that anybody who visits the same
board later sees the reordering, with some exceptions.
2021-11-18 22:05:49 +05:30
Any time you drag and reorder the issue, its relative order value changes accordingly.
Then, any time that issue appears in any board, the ordering is done according to
the updated relative order value. If a user in your GitLab instance
2021-01-03 14:25:43 +05:30
drags issue `A` above issue `B`, the ordering is maintained when these two issues are subsequently
2021-12-11 22:18:48 +05:30
loaded in any board in the same instance.
This could be a different project board or a different group
2021-01-03 14:25:43 +05:30
board, for example.
2020-11-24 15:15:51 +05:30
This ordering also affects [issue lists](issues/sorting_issue_lists.md).
Changing the order in an issue board changes the ordering in an issue list,
and vice versa.
## GitLab Enterprise features for issue boards
2021-03-11 19:13:27 +05:30
GitLab issue boards are available on the GitLab Free tier, but some
2020-11-24 15:15:51 +05:30
advanced functionality is present in [higher tiers only](https://about.gitlab.com/pricing/).
2018-12-05 23:21:45 +05:30
2021-03-11 19:13:27 +05:30
### Configurable issue boards **(PREMIUM)**
2020-05-24 23:13:21 +05:30
2021-03-08 18:12:59 +05:30
> - Setting current iteration as scope [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196804) in GitLab 13.8.
2021-03-11 19:13:27 +05:30
> - Moved to GitLab Premium in 13.9.
2020-05-24 23:13:21 +05:30
2021-03-08 18:12:59 +05:30
An issue board can be associated with a [milestone](milestones/index.md#milestones),
[labels](labels.md), assignee, weight, and current [iteration](../group/iterations/index.md),
2021-01-03 14:25:43 +05:30
which automatically filter the board issues accordingly.
2018-12-05 23:21:45 +05:30
This allows you to create unique boards according to your team's need.
2021-01-29 00:20:46 +05:30
![Create scoped board](img/issue_board_creation_v13_6.png)
2018-12-05 23:21:45 +05:30
2021-01-29 00:20:46 +05:30
You can define the scope of your board when creating it or by clicking the **Edit board** button.
2021-03-08 18:12:59 +05:30
After a milestone, iteration, assignee, or weight is assigned to an issue board, you can no longer
2020-04-22 19:07:51 +05:30
filter through these in the search bar. In order to do that, you need to remove the desired scope
2020-05-24 23:13:21 +05:30
(for example, milestone, assignee, or weight) from the issue board.
2018-12-05 23:21:45 +05:30
2020-05-24 23:13:21 +05:30
If you don't have editing permission in a board, you're still able to see the configuration by
clicking **View scope**.
2018-12-05 23:21:45 +05:30
2020-11-24 15:15:51 +05:30
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
Watch a [video presentation](https://youtu.be/m5UTNCSqaDk) of
2021-11-11 11:23:49 +05:30
the configurable issue board feature.
2020-11-24 15:15:51 +05:30
2020-04-22 19:07:51 +05:30
### Focus mode
2018-12-05 23:21:45 +05:30
2021-03-11 19:13:27 +05:30
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28597) to GitLab Free SaaS in 12.10.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212331) to GitLab Free self-managed in 13.0.
2018-12-05 23:21:45 +05:30
2021-01-29 00:20:46 +05:30
To enable or disable focus mode, select the **Toggle focus mode** button (**{maximize}**) at the top
right. In focus mode, the navigation UI is hidden, allowing you to focus on issues in the board.
2020-05-24 23:13:21 +05:30
2021-03-11 19:13:27 +05:30
### Sum of issue weights **(PREMIUM)**
> Moved to GitLab Premium in 13.9.
2018-12-05 23:21:45 +05:30
The top of each list indicates the sum of issue weights for the issues that
belong to that list. This is useful when using boards for capacity allocation,
2020-11-24 15:15:51 +05:30
especially in combination with [assignee lists](#assignee-lists).
2018-12-05 23:21:45 +05:30
2021-01-29 00:20:46 +05:30
![issue board summed weights](img/issue_board_summed_weights_v13_6.png)
2020-05-24 23:13:21 +05:30
2021-09-04 01:27:46 +05:30
### Group issue boards
2018-12-05 23:21:45 +05:30
2021-01-03 14:25:43 +05:30
Accessible at the group navigation level, a group issue board offers the same features as a project-level board.
2021-09-04 01:27:46 +05:30
It can display issues from all projects that fall under the group and its descendant subgroups.
2021-04-17 20:07:23 +05:30
2021-09-04 01:27:46 +05:30
Users on GitLab Free can use a single group issue board.
2021-04-17 20:07:23 +05:30
2019-09-30 21:07:59 +05:30
### Assignee lists **(PREMIUM)**
2018-12-05 23:21:45 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5784) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.0.
2018-12-05 23:21:45 +05:30
2021-01-03 14:25:43 +05:30
As in a regular list showing all issues with a chosen label, you can add
2020-05-24 23:13:21 +05:30
an assignee list that shows all issues assigned to a user.
2018-12-05 23:21:45 +05:30
You can have a board with both label lists and assignee lists. To add an
assignee list:
2021-10-27 15:23:28 +05:30
1. Select **Create list**.
1. Select **Assignee**.
1. In the dropdown, select a user.
1. Select **Add to board**.
2018-12-05 23:21:45 +05:30
Now that the assignee list is added, you can assign or unassign issues to that user
2021-09-04 01:27:46 +05:30
by [moving issues](#move-issues-and-lists) to and from an assignee list.
2018-12-05 23:21:45 +05:30
To remove an assignee list, just as with a label list, click the trash icon.
2021-10-27 15:23:28 +05:30
![Assignee lists](img/issue_board_assignee_lists_v14_1.png)
2018-12-05 23:21:45 +05:30
2019-09-30 21:07:59 +05:30
### Milestone lists **(PREMIUM)**
2018-12-05 23:21:45 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/6469) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2.
2018-12-05 23:21:45 +05:30
2020-05-24 23:13:21 +05:30
You're also able to create lists of a milestone. These are lists that filter issues by the assigned
milestone, giving you more freedom and visibility on the issue board. To add a milestone list:
2018-12-05 23:21:45 +05:30
2021-10-27 15:23:28 +05:30
1. Select **Create list**.
1. Select **Milestone**.
1. In the dropdown, select a milestone.
1. Select **Add to board**.
2018-12-05 23:21:45 +05:30
2021-09-04 01:27:46 +05:30
Like the assignee lists, you're able to [drag issues](#move-issues-and-lists)
2020-05-24 23:13:21 +05:30
to and from a milestone list to manipulate the milestone of the dragged issues.
As in other list types, click the trash icon to remove a list.
2018-12-05 23:21:45 +05:30
2021-10-27 15:23:28 +05:30
![Milestone lists](img/issue_board_milestone_lists_v14_1.png)
2021-01-29 00:20:46 +05:30
2021-04-29 21:17:54 +05:30
### Iteration lists **(PREMIUM)**
2022-01-26 12:08:38 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/250479) in GitLab 13.11 [with a flag](../../administration/feature_flags.md) named `iteration_board_lists`. Enabled by default.
> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/75404) in GitLab 14.6. Feature flag `iteration_board_lists` removed.
2021-04-29 21:17:54 +05:30
You're also able to create lists of an iteration.
2022-01-26 12:08:38 +05:30
These lists filter issues by the assigned iteration.
To add an iteration list:
2021-04-29 21:17:54 +05:30
1. Select **Create list**.
2021-10-27 15:23:28 +05:30
1. Select **Iteration**.
2021-04-29 21:17:54 +05:30
1. In the dropdown, select an iteration.
1. Select **Add to board**.
2021-09-04 01:27:46 +05:30
Like the milestone lists, you're able to [drag issues](#move-issues-and-lists)
2021-04-29 21:17:54 +05:30
to and from a iteration list to manipulate the iteration of the dragged issues.
![Iteration lists](img/issue_board_iteration_lists_v13_10.png)
2021-01-29 00:20:46 +05:30
### Group issues in swimlanes **(PREMIUM)**
2021-03-08 18:12:59 +05:30
> - Grouping by epic [introduced](https://gitlab.com/groups/gitlab-org/-/epics/3352) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.6.
> - Editing issue titles in the issue sidebar [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/232745) in GitLab 13.8.
2021-04-17 20:07:23 +05:30
> - Editing iteration in the issue sidebar [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/290232) in GitLab 13.9.
2021-01-29 00:20:46 +05:30
With swimlanes you can visualize issues grouped by epic.
Your issue board keeps all the other features, but with a different visual organization of issues.
This feature is available both at the project and group level.
2021-02-22 17:27:13 +05:30
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For a video overview, see [Epics Swimlanes Walkthrough - 13.6](https://www.youtube.com/watch?v=nHC7-kz5P2g) (November 2020).
2021-01-29 00:20:46 +05:30
To group issues by epic in an issue board:
1. Select the **Group by** dropdown button.
1. Select **Epic**.
2021-10-27 15:23:28 +05:30
![Epics Swimlanes](img/epics_swimlanes_v14_1.png)
2021-01-29 00:20:46 +05:30
2021-03-08 18:12:59 +05:30
To edit an issue without leaving this view, select the issue card (not its title), and a sidebar
appears on the right. There you can see and edit the issue's:
- Title
- Assignees
2021-11-11 11:23:49 +05:30
- Epic **(PREMIUM)**
2021-03-08 18:12:59 +05:30
- Milestone
- Time tracking value (view only)
- Due date
- Labels
- Weight
- Notifications setting
2021-09-04 01:27:46 +05:30
You can also [drag issues](#move-issues-and-lists) to change their position and epic assignment:
2021-01-29 00:20:46 +05:30
- To reorder an issue, drag it to the new position within a list.
- To assign an issue to another epic, drag it to the epic's horizontal lane.
- To unassign an issue from an epic, drag it to the **Issues with no epic assigned** lane.
- To move an issue to another epic _and_ another list, at the same time, drag the issue diagonally.
![Drag issues between swimlanes](img/epics_swimlanes_drag_and_drop.png)
2018-12-05 23:21:45 +05:30
2021-03-11 19:13:27 +05:30
## Work In Progress limits **(PREMIUM)**
2020-03-13 15:44:24 +05:30
2021-03-11 19:13:27 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11403) in GitLab 12.7
> - Moved to GitLab Premium in 13.9.
2020-03-13 15:44:24 +05:30
2020-10-24 23:57:45 +05:30
You can set a Work In Progress (WIP) limit for each issue list on an issue board. When a limit is
set, the list's header shows the number of issues in the list and the soft limit of issues.
You cannot set a WIP limit on the default lists (**Open** and **Closed**).
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
Examples:
2020-03-13 15:44:24 +05:30
2021-01-03 14:25:43 +05:30
- When you have a list with four issues and a limit of five, the header shows **4/5**.
2020-05-24 23:13:21 +05:30
If you exceed the limit, the current number of issues is shown in red.
- You have a list with five issues with a limit of five. When you move another issue to that list,
the list's header displays **6/5**, with the six shown in red.
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
To set a WIP limit for a list:
2018-12-05 23:21:45 +05:30
2020-05-24 23:13:21 +05:30
1. Navigate to a Project or Group board of which you're a member.
2020-10-24 23:57:45 +05:30
1. Click the settings icon in a list's header.
2020-05-24 23:13:21 +05:30
1. Next to **Work In Progress Limit**, click **Edit**.
1. Enter the maximum number of issues.
1. Press <kbd>Enter</kbd> to save.
2018-12-05 23:21:45 +05:30
2021-09-30 23:02:18 +05:30
## Blocked issues **(PREMIUM)**
2020-03-13 15:44:24 +05:30
2021-04-29 21:17:54 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34723) in GitLab 12.8.
> - [View blocking issues when hovering over blocked icon](https://gitlab.com/gitlab-org/gitlab/-/issues/210452) in GitLab 13.10.
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
If an issue is blocked by another issue, an icon appears next to its title to indicate its blocked
status.
2020-03-13 15:44:24 +05:30
2021-04-29 21:17:54 +05:30
When you hover over the blocked icon (**{issue-block}**), a detailed information popover is displayed.
![Blocked issues](img/issue_boards_blocked_icon_v13_10.png)
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
## Actions you can take on an issue board
2021-09-04 01:27:46 +05:30
- [Edit an issue](#edit-an-issue).
2020-05-24 23:13:21 +05:30
- [Create a new list](#create-a-new-list).
2021-01-29 00:20:46 +05:30
- [Remove an existing list](#remove-a-list).
2020-05-24 23:13:21 +05:30
- [Remove an issue from a list](#remove-an-issue-from-a-list).
- [Filter issues](#filter-issues) that appear across your issue board.
- [Create workflows](#create-workflows).
2021-09-04 01:27:46 +05:30
- [Move issues and lists](#move-issues-and-lists).
2020-06-23 00:09:42 +05:30
- [Multi-select issue cards](#multi-select-issue-cards).
2020-05-24 23:13:21 +05:30
- Drag and reorder the lists.
- Change issue labels (by dragging an issue between lists).
2021-09-04 01:27:46 +05:30
- Close an issue (by dragging it to the **Closed** list).
2016-09-13 17:45:13 +05:30
2020-05-24 23:13:21 +05:30
If you're not able to do some of the things above, make sure you have the right
[permissions](#permissions).
2016-09-13 17:45:13 +05:30
2021-09-04 01:27:46 +05:30
### Edit an issue
2022-01-26 12:08:38 +05:30
> Editing title, iteration, and confidentiality [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/248908) in GitLab 14.1.
2021-09-04 01:27:46 +05:30
You can edit an issue without leaving the board view.
To open the right sidebar, select an issue card (not its title).
You can edit the following issue attributes in the right sidebar:
- Assignees
2022-01-26 12:08:38 +05:30
- Confidentiality
2021-09-04 01:27:46 +05:30
- Due date
2022-01-26 12:08:38 +05:30
- [Epic](../group/epics/index.md)
- [Iteration](../group/iterations/index.md)
2021-09-04 01:27:46 +05:30
- Labels
2022-01-26 12:08:38 +05:30
- Milestone
2021-09-04 01:27:46 +05:30
- Notifications setting
- Title
2022-01-26 12:08:38 +05:30
- [Weight](issues/issue_weight.md)
Additionally, you can also see the time tracking value.
2021-09-04 01:27:46 +05:30
2020-05-24 23:13:21 +05:30
### Create a new list
2016-09-13 17:45:13 +05:30
2021-10-27 15:23:28 +05:30
Create a new list by clicking the **Create** button in the upper right corner of the issue board.
2016-09-13 17:45:13 +05:30
2021-10-27 15:23:28 +05:30
![creating a new list in an issue board](img/issue_board_add_list_v14_1.png)
2016-09-13 17:45:13 +05:30
2021-10-27 15:23:28 +05:30
Then, choose the label, user or milestone to base the new list on. The new list is inserted
at the end of the lists, before **Closed**. To move and reorder lists, drag them around.
2016-09-13 17:45:13 +05:30
2021-01-29 00:20:46 +05:30
### Remove a list
2016-09-13 17:45:13 +05:30
2021-01-29 00:20:46 +05:30
Removing a list doesn't have any effect on issues and labels, as it's just the
2021-09-04 01:27:46 +05:30
list view that's removed. You can always create it again later if you need.
2016-09-13 17:45:13 +05:30
2021-01-29 00:20:46 +05:30
To remove a list from an issue board:
2021-09-04 01:27:46 +05:30
1. On the top of the list you want to remove, select the **List settings** icon (**{settings}**).
The list settings sidebar opens on the right.
2021-01-29 00:20:46 +05:30
1. Select **Remove list**. A confirmation dialog appears.
1. Select **OK**.
2021-04-29 21:17:54 +05:30
### Add issues to a list
2021-02-22 17:27:13 +05:30
2021-04-29 21:17:54 +05:30
> The **Add issues** button was [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57329) in GitLab 13.11.
2017-08-17 22:00:37 +05:30
2021-04-29 21:17:54 +05:30
If your board is scoped to one or more attributes, go to the issues you want to add and apply the
same attributes as your board scope.
2017-08-17 22:00:37 +05:30
2021-04-29 21:17:54 +05:30
For example, to add an issue to a list scoped to the `Doing` label, in a group issue board:
2021-01-29 00:20:46 +05:30
2021-04-29 21:17:54 +05:30
1. Go to an issue in the group or one of the subgroups or projects.
1. Add the `Doing` label.
The issue should now show in the `Doing` list on your issue board.
2017-08-17 22:00:37 +05:30
2020-05-24 23:13:21 +05:30
### Remove an issue from a list
2018-03-17 18:26:18 +05:30
2021-04-17 20:07:23 +05:30
> The **Remove from board** button was [removed](https://gitlab.com/gitlab-org/gitlab/-/issues/229507) in GitLab 13.10.
When an issue should no longer belong to a list, you can remove it.
The steps depend on the scope of the list:
2018-11-08 19:23:39 +05:30
2021-04-17 20:07:23 +05:30
1. To open the right sidebar, select the issue card.
1. Remove what's keeping the issue in the list.
If it's a label list, remove the label. If it's an [assignee list](#assignee-lists), unassign the user.
2016-09-13 17:45:13 +05:30
2020-05-24 23:13:21 +05:30
### Filter issues
2016-09-13 17:45:13 +05:30
2021-09-04 01:27:46 +05:30
You can use the filters on top of your issue board to show only
the results you want. It's similar to the filtering used in the [issue tracker](issues/index.md).
2016-09-13 17:45:13 +05:30
2021-01-29 00:20:46 +05:30
You can filter by the following:
- Assignee
- Author
- Epic
2021-02-22 17:27:13 +05:30
- Iteration ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.6)
2021-01-29 00:20:46 +05:30
- Label
- Milestone
- My Reaction
- Release
- Weight
2016-09-13 17:45:13 +05:30
2021-09-04 01:27:46 +05:30
#### Filtering issues in a group board
When [filtering issues](#filter-issues) in a **group** board, keep this behavior in mind:
- Milestones: you can filter by the milestones belonging to the group and its descendant groups.
- Labels: you can only filter by the labels belonging to the group but not its descendant groups.
When you edit issues individually using the right sidebar, you can additionally select the
milestones and labels from the **project** that the issue is from.
2020-05-24 23:13:21 +05:30
### Create workflows
2016-09-13 17:45:13 +05:30
2020-05-24 23:13:21 +05:30
By reordering your lists, you can create workflows. As lists in issue boards are
2020-11-24 15:15:51 +05:30
based on labels, it works out of the box with your existing issues.
So if you've already labeled things with **Backend** and **Frontend**, the issue appears in
2021-01-29 00:20:46 +05:30
the lists as you create them. In addition, this means you can move something between lists by
changing a label.
2016-09-13 17:45:13 +05:30
2020-05-24 23:13:21 +05:30
A typical workflow of using an issue board would be:
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
1. You have [created](labels.md#label-management) and [prioritized](labels.md#label-priority)
2021-01-29 00:20:46 +05:30
labels to categorize your issues.
2016-09-13 17:45:13 +05:30
1. You have a bunch of issues (ideally labeled).
2020-05-24 23:13:21 +05:30
1. You visit the issue board and start [creating lists](#create-a-new-list) to
2016-09-13 17:45:13 +05:30
create a workflow.
1. You move issues around in lists so that your team knows who should be working
on what issue.
1. When the work by one team is done, the issue can be dragged to the next list
2020-11-24 15:15:51 +05:30
so someone else can pick it up.
2016-09-13 17:45:13 +05:30
1. When the issue is finally resolved, the issue is moved to the **Done** list
and gets automatically closed.
2020-11-24 15:15:51 +05:30
For example, you can create a list based on the label of **Frontend** and one for
**Backend**. A designer can start working on an issue by adding it to the
**Frontend** list. That way, everyone knows that this issue is now being
worked on by the designers.
2021-01-29 00:20:46 +05:30
Then, when they're done, all they have to do is
2021-01-03 14:25:43 +05:30
drag it to the next list, **Backend**. Then, a backend developer can
2021-04-29 21:17:54 +05:30
eventually pick it up. When they're done, they move it to **Done**, to close the
2016-09-13 17:45:13 +05:30
issue.
2021-01-03 14:25:43 +05:30
This process can be seen clearly when visiting an issue. With every move
to another list, the label changes and a system note is recorded.
2016-09-13 17:45:13 +05:30
2021-01-29 00:20:46 +05:30
![issue board system notes](img/issue_board_system_notes_v13_6.png)
2016-09-13 17:45:13 +05:30
2021-09-04 01:27:46 +05:30
### Move issues and lists
You can move issues and lists by dragging them.
Prerequisites:
2018-11-08 19:23:39 +05:30
2021-12-11 22:18:48 +05:30
- You must have at least the Reporter [role](../permissions.md#project-members-permissions) for a project in GitLab.
2018-11-08 19:23:39 +05:30
2021-09-04 01:27:46 +05:30
To move an issue, select the issue card and drag it to another position in its current list or
into a different list. Learn about possible effects in [Dragging issues between lists](#dragging-issues-between-lists).
To move a list, select its top bar, and drag it horizontally.
You can't move the **Open** and **Closed** lists, but you can hide them when editing an issue board.
#### Dragging issues between lists
To move an issue to another list, select the issue card and drag it onto that list.
When you drag issues between lists, the result is different depending on the source list
and the target list.
| | To Open | To Closed | To label B list | To assignee Bob list |
| ---------------------------- | -------------- | ----------- | ------------------------------ | ----------------------------- |
| **From Open** | - | Close issue | Add label B | Assign Bob |
| **From Closed** | Reopen issue | - | Reopen issue and add label B | Reopen issue and assign Bob |
| **From label A list** | Remove label A | Close issue | Remove label A and add label B | Assign Bob |
| **From assignee Alice list** | Unassign Alice | Close issue | Add label B | Unassign Alice and assign Bob |
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
### Multi-select issue cards
2021-09-04 01:27:46 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18954) in GitLab 12.4.
> - [Placed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/61955) behind a [feature flag](../feature_flags.md), disabled by default in GitLab 14.0.
2022-01-26 12:08:38 +05:30
FLAG:
On self-managed GitLab, by default this feature is not available. To make it available, ask an
administrator to [enable the feature flag](../../administration/feature_flags.md) named `board_multi_select`.
On GitLab.com, this feature is not available.
The feature is not ready for production use.
2020-04-08 14:13:33 +05:30
2021-01-29 00:20:46 +05:30
You can select multiple issue cards, then drag the group to another position within the list, or to
another list. This makes it faster to reorder many issues at once.
2020-04-08 14:13:33 +05:30
To select and move multiple cards:
2021-03-11 19:13:27 +05:30
1. Select each card with <kbd>Control</kbd>+`Click` on Windows or Linux, or <kbd>Command</kbd>+`Click` on MacOS.
2020-04-22 19:07:51 +05:30
1. Drag one of the selected cards to another position or list and all selected cards are moved.
2020-04-08 14:13:33 +05:30
![Multi-select Issue Cards](img/issue_boards_multi_select_v12_4.png)
2021-02-22 17:27:13 +05:30
### First time using an issue board
> - The automatic creation of the **To Do** and **Doing** lists [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/202144) in GitLab 13.5.
> - [Deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/270583) in GitLab 13.7. In GitLab 13.7 and later, the **To Do** and **Doing** columns are not automatically created.
WARNING:
This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/270583) in GitLab 13.7.
The **To Do** and **Doing** columns are no longer automatically created.
In GitLab 13.5 and 13.6, the first time you open an issue board, you are presented with the default lists
(**Open**, **To Do**, **Doing**, and **Closed**).
If the **To Do** and **Doing** labels don't exist in the project or group, they are created, and
their lists appear as empty. If any of them already exists, the list is filled with the issues that
have that label.
2016-09-13 17:45:13 +05:30
## Tips
A few things to remember:
- Moving an issue between lists removes the label from the list it came from
and adds the label from the list it goes to.
- An issue can exist in multiple lists if it has more than one label.
- Lists are populated with issues automatically if the issues are labeled.
2020-05-24 23:13:21 +05:30
- Clicking the issue title inside a card takes you to that issue.
- Clicking a label inside a card quickly filters the entire issue board
2016-09-13 17:45:13 +05:30
and show only the issues from all lists that have that label.
- For performance and visibility reasons, each list shows the first 20 issues
2020-04-22 19:07:51 +05:30
by default. If you have more than 20 issues, start scrolling down and the next
2020-11-24 15:15:51 +05:30
20 appear.