index.md 10.0 KB
Newer Older
1 2 3 4
---
type: reference, howto
---

5
# Epics **(ULTIMATE)**
6

7
> Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.2.
8 9 10 11 12

Epics let you manage your portfolio of projects more efficiently and with less
effort by tracking groups of issues that share a theme, across projects and
milestones.

13
![epics list view](img/epics_list_view_v12.3.png)
14 15 16 17 18

## Use cases

- Suppose your team is working on a large feature that involves multiple discussions throughout different issues created in distinct projects within a [Group](../index.md). With Epics, you can track all the related activities that together contribute to that single feature.
- Track when the work for the group of issues is targeted to begin, and when it is targeted to end.
19
- Discuss and collaborate on feature ideas and scope at a high level.
20 21 22 23 24 25 26

## Creating an epic

A paginated list of epics is available in each group from where you can create
a new epic. The list of epics includes also epics from all subgroups of the
selected group. From your group page:

27 28 29
1. Go to **Epics**.
1. Click **New epic**.
1. Enter a descriptive title and click **Create epic**.
30

31
You will be taken to the new epic where can edit the following details:
32

33 34 35 36 37 38 39 40 41 42 43 44 45
- Title
- Description
- Start date
- Due date
- Labels

An epic's page contains the following tabs:

- **Epics and Issues**: epics and issues added to this epic. Child epics, and their issues, are shown in a tree view.
  - Click on the <kbd>></kbd> beside a parent epic to reveal the child epics and issues.
- **Roadmap**: a roadmap view of child epics which have start and due dates.

![epic view](img/epic_view_v12.3.png)
46 47 48

## Adding an issue to an epic

49 50 51
Any issue that belongs to a project in the epic's group, or any of the epic's
subgroups, are eligible to be added.  New issues appear at the top of the list of issues in the **Epics and Issues** tab.

52
An epic contains a list of issues and an issue can be associated with at most
53 54
one epic. When you add an issue to an epic that is already associated with another epic,
the issue is automatically removed from the previous epic.
55

56 57 58 59 60
To add an issue to an epic:

1. Click **Add an issue**.
1. Paste the link of the issue.
   - Press <kbd>Spacebar</kbd> and repeat this step if there are multiple issues.
61 62
1. Click **Add**.

63
To remove an issue from an epic:
64

65 66
1. Click on the <kbd>x</kbd> button in the epic's issue list.
1. Click **Remove** in the **Remove issue** warning message.
67 68 69

## Multi-level child epics

70
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/8333) in GitLab Ultimate 11.7.
71

72 73 74 75 76 77 78 79
Any epic that belongs to a group, or subgroup of the parent epic's group, is
eligible to be added. New child epics appear at the top of the list of epics in the **Epics and Issues** tab.

When you add a child epic that is already associated with another epic,
that epic is automatically removed from the previous epic.

An epic can have multiple child epics with
the maximum depth being 5.
80

81 82 83
To add a child epic:

1. Click **Add an epic**.
84
1. Paste the link of the epic.
85
   - Press <kbd>Spacebar</kbd> and repeat this step if there are multiple issues.
86 87
1. Click **Add**.

88 89 90 91
To remove a child epic from a parent epic:

1. Click on the <kbd>x</kbd> button in the parent epic's list of epics.
1. Click **Remove** in the **Remove epic** warning message.
92 93 94

## Start date and due date

95
To set a **Start date** and **Due date** for an epic, you can choose either of the following:
96

97 98
- **Fixed**: Enter a fixed value.
- **From milestones:** Inherit a dynamic value from the issues added to the epic.
99

100
If you select **From milestones** for the start date, GitLab will automatically set the
101
date to be earliest start date across all milestones that are currently assigned
102
to the issues that are added to the epic. Similarly, if you select "From milestones"
103 104 105
for the due date, GitLab will set it to be the latest due date across all
milestones that are currently assigned to those issues.

106
These are dynamic dates which are recalculated immediately if any of the following occur:
107

108 109 110 111 112
- Milestones are re-assigned to the issues.
- Milestone dates change.
- Issues are added or removed from the epic.

## Roadmap
113

114
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/7327) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.10.
115 116

If your epic contains one or more [child epics](#multi-level-child-epics) which
117 118
have a [start or due date](#start-date-and-due-date), a
[roadmap](../roadmap/index.md) view of the child epics is listed under the parent epic.
119

120
![Child epics roadmap](img/epic_view_roadmap_v12.3.png)
121 122 123

## Reordering issues and child epics

124 125 126 127 128 129 130 131 132 133 134
New issues and child epics are added to the top of their respective lists in the **Epics and Issues** tab. You can reorder the list of issues and the list of child epics. Issues and child epics cannot be intermingled.

To reorder issues assigned to an epic:

1. Go to the **Epics and Issues** tab.
1. Drag and drop issues into the desired order.

To reorder child epics assigned to an epic:

1. Go to the **Epics and Issues** tab.
1. Drag and drop epics into the desired order.
135

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
## Updating epics

### Using bulk editing

To apply labels across multiple epics:

1. Go to the Epics list.
1. Click **Edit epics**.
    - Checkboxes will appear beside each epic.
    - A sidebar on the right-hand side will appear, with an editable field for labels.
1. Check the checkbox beside each epic to be edited.
1. Select the desired labels.
1. Click **Update all**.

![bulk editing](img/bulk_editing.png)

152 153 154
## Deleting an epic

NOTE: **Note:**
155
To delete an epic, you need to be an [Owner](../../permissions.md#group-members-permissions) of a group/subgroup.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188

When inside a single epic view, click the **Delete** button to delete the epic.
A modal will pop-up to confirm your action.

Deleting an epic releases all existing issues from their associated epic in the
system.

## Closing and reopening epics

### Using buttons

Whenever you decide that there is no longer need for that epic,
close the epic using the close button:

![close epic - button](img/button_close_epic.png)

You can always reopen it using the reopen button.

![reopen epic - button](img/button_reopen_epic.png)

### Using quick actions

You can close or reopen an epic using [Quick actions](../../project/quick_actions.md)

## Navigating to an epic from an issue

If an issue belongs to an epic, you can navigate to the containing epic with the
link in the issue sidebar.

![containing epic](img/containing_epic.png)

## Promoting an issue to an epic

189
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/3777) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.6.
190 191 192

If you have [permissions](../../permissions.md) to close an issue and create an
epic in the parent group, you can promote an issue to an epic with the `/promote`
193
[quick action](../../project/quick_actions.md#quick-actions-for-issues-merge-requests-and-epics).
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
Only issues from projects that are in groups can be promoted.

When the quick action is executed:

- An epic is created in the same group as the project of the issue.
- Subscribers of the issue are notified that the epic was created.

The following issue metadata will be copied to the epic:

- Title, description, activity/comment thread.
- Upvotes/downvotes.
- Participants.
- Group labels that the issue already has.

## Searching for an epic from epics list page

210
> Introduced in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.5.
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248

You can search for an epic from the list of epics using filtered search bar (similar to
that of Issues and Merge requests) based on following parameters:

- Title or description
- Author name / username
- Labels

![epics search](img/epics_search.png)

To search, go to the list of epics and click on the field **Search or filter results...**.
It will display a dropdown menu, from which you can add an author. You can also enter plain
text to search by epic title or description. When done, press <kbd>Enter</kbd> on your
keyboard to filter the list.

You can also sort epics list by:

- **Created date**
- **Last updated**
- **Start date**
- **Due date**

Each option contains a button that can toggle the order between **ascending** and **descending**. The sort option and order will be persisted to be used wherever epics are browsed including the [roadmap](../roadmap/index.md).

![epics sort](img/epics_sort.png)

## Permissions

If you have access to view an epic and have access to view an issue already
added to that epic, then you can view the issue in the epic issue list.

If you have access to edit an epic and have access to edit an issue, then you
can add the issue to or remove it from the epic.

Note that for a given group, the visibility of all projects must be the same as
the group, or less restrictive. That means if you have access to a group's epic,
then you already have access to its projects' issues.

249
You may also consult the [group permissions table](../../permissions.md#group-members-permissions).
250 251 252 253

## Thread

- Comments: collaborate on that epic by posting comments in its thread.
E
Evan Read 已提交
254 255
  These text fields also fully support
  [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm).
256

257
## Comment, or start a thread
258 259 260 261

Once you wrote your comment, you can either:

- Click "Comment" and your comment will be published.
262
- Click "Start thread": start a thread within that epic's discussion to discuss specific points.
263 264 265 266 267

## Award emoji

- You can [award an emoji](../../award_emojis.md) to that epic or its comments.

E
Evan Read 已提交
268
## Notifications
269 270

- [Receive notifications](../../../workflow/notifications.md) for epic events.
271 272 273 274 275 276 277 278 279 280 281 282

<!-- ## Troubleshooting

Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.

Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->