debian-mirror-gitlab/doc/user/todos.md

163 lines
6 KiB
Markdown
Raw Normal View History

2019-12-26 22:10:19 +05:30
---
disqus_identifier: 'https://docs.gitlab.com/ee/workflow/todos.html'
2020-06-23 00:09:42 +05:30
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
2019-12-26 22:10:19 +05:30
---
2020-11-24 15:15:51 +05:30
# GitLab To-Do List **(CORE)**
2019-12-26 22:10:19 +05:30
2020-04-22 19:07:51 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2817) in GitLab 8.5.
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
When you sign in to GitLab, you normally want to determine where you should
spend your time. This can include taking an action, or keeping track of things
(without having to read lots of email notifications). Because GitLab is where you
do your work, being able to get started quickly is important.
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
Your *To-Do List* offers a chronological list of items waiting for your input
2021-01-29 00:20:46 +05:30
(known as *to-do items*) in a single dashboard.
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
The To-Do List supports tracking [actions](#what-triggers-a-to-do-item) related to
2020-11-24 15:15:51 +05:30
the following:
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
- Issues
- Merge Requests
- Epics **(ULTIMATE)**
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
![to-do screenshot showing a list of items to check on](img/todos_index.png)
2021-01-03 14:25:43 +05:30
You can access your To-Do List by clicking the To-Do List icon (**{task-done}**)
2021-01-29 00:20:46 +05:30
next to the search bar in the top navigation. If the to-do item count is:
2020-11-24 15:15:51 +05:30
2021-01-29 00:20:46 +05:30
- *Less than 100*, the number in blue is the number of to-do items.
2020-11-24 15:15:51 +05:30
- *100 or more*, the number displays as 99+. The exact number displays in the
To-Do List.
2019-12-26 22:10:19 +05:30
![To Do icon](img/todos_icon.png)
2021-01-29 00:20:46 +05:30
## What triggers a to-do item
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
A to-do item appears on your To-Do List when:
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
- An issue or merge request is assigned to you.
- You're `@mentioned` in the description or comment of an issue or merge request
(or epic **(ULTIMATE)**).
2020-04-22 19:07:51 +05:30
- You are `@mentioned` in a comment on a:
- Commit
2020-05-24 23:13:21 +05:30
- Design
2020-11-24 15:15:51 +05:30
- 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're the author.
- You're the user that set the merge request to automatically merge after a
pipeline succeeds.
2021-01-03 14:25:43 +05:30
- [In GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/12136) and later, a
2020-11-24 15:15:51 +05:30
merge request is removed from a
[merge train](../ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/index.md),
and you're the user that added it. **(PREMIUM)**
When several trigger actions occur for the same user on the same object (for
2021-01-03 14:25:43 +05:30
example, an issue), GitLab displays only the first action as a single to do
2020-11-24 15:15:51 +05:30
item.
2021-01-29 00:20:46 +05:30
To-do item triggers aren't affected by [GitLab notification email settings](profile/notifications.md).
2019-12-26 22:10:19 +05:30
NOTE: **Note:**
2021-01-29 00:20:46 +05:30
When a user no longer has access to a resource related to a to-do item (such as
2021-01-03 14:25:43 +05:30
an issue, merge request, epic, project, or group), for security reasons GitLab
2021-01-29 00:20:46 +05:30
deletes any related to-do items within the next hour. Deletion is delayed to
2021-01-03 14:25:43 +05:30
prevent data loss, in the case where a user's access is accidentally revoked.
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
### Directly addressing a to-do item
2019-12-26 22:10:19 +05:30
2020-04-22 19:07:51 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7926) in GitLab 9.0.
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
If you're mentioned at the start of a line, the to-do item you receive will be
2021-01-03 14:25:43 +05:30
listed as *directly addressed*. For example, in the following comment:
2019-12-26 22:10:19 +05:30
```markdown
@alice What do you think? cc: @bob
- @carol can you please have a look?
>>>
@dan what do you think?
>>>
@erin @frank thank you!
```
2021-01-29 00:20:46 +05:30
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
2019-12-26 22:10:19 +05:30
for filtering purposes; otherwise, they appear as normal.
2021-01-29 00:20:46 +05:30
### Manually creating a to-do item
2019-12-26 22:10:19 +05:30
2021-01-03 14:25:43 +05:30
You can also add the following to your To-Do List by clicking the **Add a to do** button on an:
- [Issue](project/issues/index.md)
- [Merge Request](project/merge_requests/index.md)
- [Epic](group/epics/index.md) **(ULTIMATE)**
- [Design](project/issues/design_management.md)
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
![Adding a to-do item from the issuable sidebar](img/todos_add_todo_sidebar.png)
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
## Marking a to-do item as done
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
Any action to an issue or merge request (or epic **(ULTIMATE)**) will mark its
2021-01-29 00:20:46 +05:30
corresponding to-do item as done.
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
Actions that dismiss to-do items include:
2019-12-26 22:10:19 +05:30
- Changing the assignee
- Changing the milestone
- Adding/removing a label
- Commenting on the issue
2020-11-24 15:15:51 +05:30
Your To-Do List is personal, and items are only marked as done if you take
2021-01-29 00:20:46 +05:30
action. If you close the issue or merge request, your to-do item is marked as
2021-01-03 14:25:43 +05:30
done.
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
To prevent other users from closing issues without you being notified, if
someone else closes, merges, or takes action on an issue or merge request (or
2021-01-29 00:20:46 +05:30
epic **(ULTIMATE)**), your to-do item remains pending.
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
There's just one to-do item for each of these, so mentioning a user many times
in an issue only triggers one to-do item.
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
If no action is needed, you can manually mark the to-do item as done by
2021-01-03 14:25:43 +05:30
clicking its corresponding **Done** button to have GitLab remove the item from
your To-Do List.
2019-12-26 22:10:19 +05:30
2021-01-03 14:25:43 +05:30
![A to do in the To-Do List](img/todos_todo_list_item.png)
2019-12-26 22:10:19 +05:30
2021-01-29 00:20:46 +05:30
You can also mark a to-do item as done by clicking the **Mark as done** button
2021-01-03 14:25:43 +05:30
in the sidebar of an issue or merge request (or epic **(ULTIMATE)**).
2019-12-26 22:10:19 +05:30
![Mark as done from the issuable sidebar](img/todos_mark_done_sidebar.png)
2021-01-29 00:20:46 +05:30
You can mark all your to-do items as done at once by clicking the
2020-11-24 15:15:51 +05:30
**Mark all as done** button.
2019-12-26 22:10:19 +05:30
## Filtering your To-Do List
2020-11-24 15:15:51 +05:30
You can use the following types of filters with your To-Do List:
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
| Filter | Description |
| ------- | ---------------------------------------------------------------- |
| Project | Filter by project. |
| Group | Filter by group. |
2021-01-03 14:25:43 +05:30
| Author | Filter by the author that triggered the to do. |
2020-11-24 15:15:51 +05:30
| Type | Filter by issue, merge request, design, or epic. **(ULTIMATE)** |
2021-01-03 14:25:43 +05:30
| Action | Filter by the action that triggered the to do. |
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
You can also filter by more than one of these at the same time. The previously
2021-01-29 00:20:46 +05:30
described [triggering actions](#what-triggers-a-to-do-item) include:
2019-12-26 22:10:19 +05:30
2020-11-24 15:15:51 +05:30
- Any action
2020-04-22 19:07:51 +05:30
- Assigned
- Mentioned
- Added
- Pipelines
2020-11-24 15:15:51 +05:30
- Directly addressed