debian-mirror-gitlab/doc/user/group/epics/epic_boards.md
2023-01-12 18:35:48 +00:00

7.5 KiB

stage group info
Plan Product Planning To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

Epic boards (PREMIUM)

Epic boards build on the existing epic tracking functionality and labels. Your epics appear as cards in vertical lists, organized by their assigned labels.

To view an epic board:

  1. On the top bar, select Main menu > Groups and find your group.
  2. On the left sidebar, select Epics > Boards.

GitLab epic board - Premium

Create an epic board

Prerequisites:

  • You must have at least the Reporter role for a group.

To create a new epic board:

  1. On the top bar, select Main menu > Groups and find your group.
  2. On the left sidebar, select Epics > Boards.
  3. In the upper left corner, select the dropdown list with the current board name.
  4. Select Create new board.
  5. Enter the new board's title.
  6. Optional. To hide the Open or Closed lists, clear the Show the Open list and Show the Closed list checkboxes.
  7. Optional. Set board scope:
    1. Next to Scope, select Expand.
    2. Next to Labels, select Edit and select the labels to use as board scope.
  8. Select Create board.

Now you can add some lists. To change these options later, edit the board.

Delete an epic board

Introduced in GitLab 14.0.

Prerequisites:

  • You must have at least the Reporter role for a group.
  • A minimum of two boards present in a group.

To delete the active epic board:

  1. Select the dropdown list with the current board name in the upper left corner of the epic boards page.
  2. Select Delete board.
  3. Select Delete.

Actions you can take on an epic board

Create a new list

Prerequisites:

  • You must have at least the Reporter role for a group.

To create a new list:

  1. On the top bar, select Main menu > Groups and find your group.
  2. On the left sidebar, select Epics > Boards.
  3. In the upper-right corner, select Create list.
  4. In the New list column expand the Select a label dropdown list and select the label to use as list scope.
  5. Select Add to board.

Remove a list

Removing a list doesn't have any effect on epics and labels, as it's just the list view that's removed. You can always create it again later if you need.

Prerequisites:

  • You must have at least the Reporter role for a group.

To remove a list from an epic board:

  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.
  2. Select Remove list. A confirmation dialog appears.
  3. Select OK.

Create an epic from an epic board

Introduced in GitLab 14.0.

Prerequisites:

  • You must have at least the Reporter role for a group.
  • You must have created a list first.

To create an epic from a list in epic board:

  1. On the top of a list, select the New epic ({plus}) icon.
  2. Enter the new epic's title.
  3. Select Create epic.

Create a GitLab epic from an epic board

Filter epics

Introduced in GitLab 14.0.

Use the filters on top of your epic board to show only the results you want. It's similar to the filtering used in the epic list, as the metadata from the epics and labels is re-used in the epic board.

You can filter by the following:

  • Author
  • Label

View count of issues, weight, and progress of an epic

Introduced in GitLab 14.1.

Epics on an epic board show a summary of their issues, weight, and progress. To see the number of open and closed issues and the completed and incomplete weight, hover over the issues icon {issues}, weight icon {weight}, or progress icon {progress}.

Move epics and lists

Introduced in GitLab 14.0.

You can move epics and lists by dragging them.

Prerequisites:

  • You must have at least the Reporter role for a group.

To move an epic, select the epic card and drag it to another position in its current list or into another list. Learn about possible effects in Dragging epics 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 epic board.

Move an epic to the start of the list

Introduced in GitLab 15.4.

When you have many epics, it's inconvenient to manually drag an epic from the bottom of a board list all the way to the top. You can move epics to the top of the list with a menu shortcut.

Your epic is moved to the top of the list even if other epics are hidden by a filter.

Prerequisites:

  • You must at least have the Reporter role for a group.

To move an epic to the start of the list:

  1. In an epic board, hover over the card of the epic you want to move.
  2. Select the vertical ellipsis ({ellipsis_v}), then Move to start of list.

Move an epic to the end of the list

Introduced in GitLab 15.4.

When you have many epics, it's inconvenient to manually drag an epic from the top of a board list all the way to the bottom. You can move epics to the bottom of the list with a menu shortcut.

Your epic is moved to the bottom of the list even if other epics are hidden by a filter.

Prerequisites:

  • You must at least have the Reporter role for a group.

To move an epic to the end of the list:

  1. In an epic board, hover over the card of the epic you want to move.
  2. Select the vertical ellipsis ({ellipsis_v}), then Move to end of list.

Dragging epics between lists

When you drag epics between lists, the result is different depending on the source list and the target list.

To Open To Closed To label B list
From Open - Close epic Add label B
From Closed Reopen epic - Reopen epic and add label B
From label A list Remove label A Close epic Remove label A and add label B

Edit the scope of an epic board

Prerequisites:

  • You must have at least the Reporter role for a group.

To edit the scope of an epic board:

  1. In the upper-right corner, select Edit board.
  2. Optional:
    • Edit the board's title.
    • Show or hide the Open and Closed columns.
    • Select other labels as the board's scope.
  3. Select Save changes.