159 lines
5.4 KiB
Markdown
159 lines
5.4 KiB
Markdown
---
|
|
disqus_identifier: 'https://docs.gitlab.com/ee/workflow/todos.html'
|
|
stage: Plan
|
|
group: Project Management
|
|
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/#designated-technical-writers
|
|
---
|
|
|
|
# GitLab To-Do List
|
|
|
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2817) in GitLab 8.5.
|
|
|
|
When you log into GitLab, you normally want to see where you should spend your
|
|
time, take some action, or know what you need to keep an eye on without
|
|
a huge pile of e-mail notifications. GitLab is where you do your work,
|
|
so being able to get started quickly is important.
|
|
|
|
Your To-Do List offers a chronological list of items that are waiting for your input, all
|
|
in a simple dashboard.
|
|
|
|
|
|
|
|
You can quickly access your To-Do List by clicking the checkmark icon next to the
|
|
search bar in the top navigation. If the count is:
|
|
|
|
- Less than 100, the number in blue is the number of To-Do items.
|
|
- 100 or more, the number displays as 99+. The exact number displays
|
|
on the To-Do List.
|
|
you still have open. Otherwise, the number displays as 99+. The exact number
|
|
displays on the To-Do List.
|
|
|
|
|
|
|
|
## What triggers a To Do
|
|
|
|
A To Do appears on your To-Do List when:
|
|
|
|
- An issue or merge request is assigned to you
|
|
- You are `@mentioned` in the description or comment of an:
|
|
- Issue
|
|
- Merge Request
|
|
- Epic **(ULTIMATE)**
|
|
- You are `@mentioned` in a comment on a:
|
|
- Commit
|
|
- Design
|
|
- The CI/CD pipeline for your merge request failed
|
|
- An open merge request becomes unmergeable due to conflict, and one of the following is true:
|
|
- You are the author
|
|
- You are the user that set it to automatically merge once the pipeline succeeds
|
|
- [Since GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/12136), a merge request
|
|
is removed from a [merge train](../ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md)
|
|
and you are the user that added it. **(PREMIUM)**
|
|
|
|
When multiple trigger actions occur for the same user on the same object (for example, an issue)
|
|
only the first is displayed as a single to-do on their To-Do List.
|
|
|
|
To-do triggers are not affected by [GitLab Notification Email settings](profile/notifications.md).
|
|
|
|
NOTE: **Note:**
|
|
When a user no longer has access to a resource related to a To Do (like an issue, merge request,
|
|
project, or group) the related To-Do items are deleted within the next hour for security reasons.
|
|
The delete is delayed to prevent data loss, in case the user's access was revoked by mistake.
|
|
|
|
### Directly addressing a To Do
|
|
|
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7926) in GitLab 9.0.
|
|
|
|
If you are mentioned at the start of a line, the To Do you receive will be listed
|
|
as 'directly addressed'. For example, in this comment:
|
|
|
|
```markdown
|
|
@alice What do you think? cc: @bob
|
|
|
|
- @carol can you please have a look?
|
|
|
|
>>>
|
|
@dan what do you think?
|
|
>>>
|
|
|
|
@erin @frank thank you!
|
|
```
|
|
|
|
The people receiving directly addressed To-Do items are `@alice`, `@erin`, and
|
|
`@frank`. Directly addressed To-Do items only differ from mentions in their type
|
|
for filtering purposes; otherwise, they appear as normal.
|
|
|
|
### Manually creating a To Do
|
|
|
|
You can also add the following to your To-Do List by clicking the **Add a To Do** button on an:
|
|
|
|
- Issue
|
|
- Merge Request
|
|
- Epic **(ULTIMATE)**
|
|
|
|
|
|
|
|
## Marking a To Do as done
|
|
|
|
Any action to the following will mark the corresponding To Do as done:
|
|
|
|
- Issue
|
|
- Merge Request
|
|
- Epic **(ULTIMATE)**
|
|
|
|
Actions that dismiss To-Do items include:
|
|
|
|
- Changing the assignee
|
|
- Changing the milestone
|
|
- Adding/removing a label
|
|
- Commenting on the issue
|
|
|
|
Your To-Do List is personal, and items are only marked as done if the action comes from
|
|
you. If you close the issue or merge request, your To Do is automatically
|
|
marked as done.
|
|
|
|
To prevent other users from closing issues without you being notified, if someone else closes, merges, or takes action on the any of the following, your To Do will remain pending:
|
|
|
|
- Issue
|
|
- Merge request
|
|
- Epic **(ULTIMATE)**
|
|
|
|
There is just one To Do for each of these, so mentioning a user a hundred times in an issue will only trigger one To Do.
|
|
|
|
If no action is needed, you can manually mark the To Do as done by clicking the
|
|
corresponding **Done** button, and it will disappear from your To-Do List.
|
|
|
|
|
|
|
|
You can also mark a To Do as done by clicking the **Mark as done** button in the sidebar of the following:
|
|
|
|
- Issue
|
|
- Merge Request
|
|
- Epic **(ULTIMATE)**
|
|
|
|
|
|
|
|
You can mark all your To-Do items as done at once by clicking the **Mark all as
|
|
done** button.
|
|
|
|
## Filtering your To-Do List
|
|
|
|
There are four kinds of filters you can use on your To-Do List.
|
|
|
|
| Filter | Description |
|
|
| ------- | ----------- |
|
|
| Project | Filter by project |
|
|
| Group | Filter by group |
|
|
| Author | Filter by the author that triggered the To Do |
|
|
| Type | Filter by issue, merge request, design, or epic **(ULTIMATE)** |
|
|
| Action | Filter by the action that triggered the To Do |
|
|
|
|
You can also filter by more than one of these at the same time. The possible Actions are
|
|
[described above](#what-triggers-a-to-do) and include:
|
|
|
|
- Any Action
|
|
- Assigned
|
|
- Mentioned
|
|
- Added
|
|
- Pipelines
|
|
- Directly Addressed
|