To-Do List
DETAILS: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated
Your To-Do List is a chronological list of items waiting for your input. The items are known as to-do items.
You can use the To-Do List to track actions related to:
Access the To-Do List
To access your To-Do List:
On the left sidebar, at the top, select To-Do list ({task-done}).
Search the To-Do List
You can search your To-Do List by to do
and done
.
You can filter to-do items per project, author, type, and action. Also, you can sort them by Label priority, Last created, and Oldest created.
Actions that create to-do items
Many to-do items are created automatically. Some of the actions that add a to-do item to your To-Do List:
- An issue or merge request is assigned to you.
- A merge request review is requested.
- You're mentioned in the description or comment of an issue, merge request, or epic.
- You're mentioned in a comment on a commit or design.
- The CI/CD pipeline for your merge request fails.
- An open merge request cannot be merged 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.
- A merge request is removed from a merge train, and you're the user that added it.
- In GitLab 15.8 and later, a member access request is raised for a group or project you're an owner of.
When several actions occur for the same user on the same object, GitLab displays the first action as a single to-do item. To change this behavior, enable multiple to-do items per object.
To-do items aren't affected by GitLab notification email settings. The only exception: If your notification setting is set to Custom and Added as approver is selected, you get a to-do item when you are eligible to approve a merge request.
Multiple to-do items per object
DETAILS: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed
- Introduced in GitLab 13.8 with a flag named
multiple_todos
. Disabled by default.- Introduced in GitLab 14.9: only mentions create multiple to-do items.
- Enabled on GitLab.com in GitLab 16.2.
FLAG:
On self-managed GitLab, by default this feature is not available. To make it available per user,
an administrator can enable the feature flag named multiple_todos
.
On GitLab.com, this feature is available. On GitLab Dedicated, this feature is not available.
This feature is not ready for production use.
When you enable this feature:
- Every time you're mentioned, GitLab creates a new to-do item for you.
- Other actions that create to-do items create one to-do item per action type on the issue, MR, and so on.
Create a to-do item
- Introduced in objectives, key results, and tasks in GitLab 16.0.
You can manually add an item to your To-Do List.
-
Go to your:
-
In the upper-right corner, select Add a to do ({todo-add}).
Create a to-do item by mentioning someone
You can create a to-do item by mentioning someone anywhere except for a code block. Mentioning a user many times in one message only creates one to-do item.
For example, from the following comment, everyone except frank
gets a to-do item created for them:
@alice What do you think? cc: @bob
- @carol can you please have a look?
> @dan what do you think?
Hey @erin, this is what they said:
```
Hi, please message @frank :incoming_envelope:
```
Re-add a done to-do item
If you marked a to-do item as done by mistake, you can re-add it from the Done tab:
- On the left sidebar, at the top, select To-Do list ({task-done}).
- At the top, select Done.
- Find the to-do item you want to re-add.
- Next to this to-do item, select Re-add this to-do item {redo}.
The to-do item is now visible in the To Do tab of the To-Do list.
Actions that mark a to-do item as done
Various actions on the to-do item object (like issue, merge request, or epic) mark its corresponding to-do item as done.
To-do items are marked as done if you:
- Add an emoji reaction to the description or comment.
- Add or remove a label.
- Change the assignee.
- Change the milestone.
- Close the to-do item's object.
- Create a comment.
- Edit the description.
- Resolve a design discussion thread.
- Accept or deny a project or group membership request.
To-do items are not marked as done if you:
- Add a linked item (like a linked issue).
- Add a child item (like child epic or task).
- Add a time entry.
- Assign yourself.
- Change the health status.
If someone else closes, merges, or takes action on an issue, merge request, or epic, your to-do item remains pending.
Mark a to-do item as done
You can manually mark a to-do item as done.
There are two ways to do this:
- In the To-Do List, to the right of the to-do item, select Mark as done ({check}).
- In the upper-right corner of the resource (for example, issue or merge request), select Mark as done ({todo-done}).
Mark all to-do items as done
You can mark all your to-do items as done at the same time.
In the To-Do List, in the upper-right corner, select Mark all as done.
How a user's To-Do List is affected when their access changes
For security reasons, GitLab deletes to-do items when a user no longer has access to a related resource. For example, if the user no longer has access to an issue, merge request, epic, project, or group, GitLab deletes the related to-do items.
This process occurs in the hour after their access changes. Deletion is delayed to prevent data loss, in case the user's access was accidentally revoked.