Skip to content

Latest commit

 

History

History
206 lines (129 loc) · 7.18 KB

time_tracking.md

File metadata and controls

206 lines (129 loc) · 7.18 KB
Raw
type stage group info
reference
Plan
Project Management
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

Time tracking (FREE)

You can estimate and track the time you spend on issues and merge requests.

Then you can view a report that shows totals over time.

Use time tracking for these tasks:

  • Record the time spent working on an issue or a merge request.
  • Add or update an estimate of the total time to complete an issue or a merge request.
  • View a breakdown of time spent working on an issue or a merge request.

You don't have to indicate an estimate to enter the time spent, and vice versa.

To enter and remove time tracking data, you must use quick actions. Type all quick actions on their own lines. If you use any quick action more than once in a single comment, only its last occurrence is applied.

You can see the data about time tracking on the right sidebar in issues and merge requests:

Time tracking in the sidebar

Estimates

The estimate is designed to show the total time needed to complete an issue or merge request.

You can see the estimated time remaining when you hover over the time tracking information in the right sidebar.

Estimated time remaining

Add an estimate

Prerequisites:

  • In issues, you must have at least the Reporter role for the project.
  • In merge requests, you must have at least the Developer role for the project.

To enter an estimate, use the /estimate quick action, followed by the time.

For example, if you need to enter an estimate of 1 month, 2 weeks, 3 days, 4 hours, and 5 minutes, type /estimate 1mo 2w 3d 4h 5m. Check the time units you can use.

An issue or a merge request can have only one estimate. Every time you enter a new time estimate, it overwrites the previous value.

Remove an estimate

Prerequisites:

  • In issues, you must have at least the Reporter role for the project.
  • In merge requests, you must have at least the Developer role for the project.

To remove an estimate entirely, use the /remove_estimate quick action.

Time spent

As you work, you can log the time you've spent.

Every new time spent entry is added to the current total time spent for the issue or the merge request.

Add time spent

Prerequisites:

  • You must have at least the Reporter role for the project.

Using the user interface

Introduced in GitLab 15.7.

To add a time entry using the user interface:

  1. In the Time tracking section of the sidebar, select Add time entry ({plus}). A modal opens.

  2. Enter:

    • The amount of time spent.
    • Optional. When it was spent.
    • Optional. A summary.

  3. Select Save.

The Spent total in the sidebar is updated and you can view all entries in a time tracking report.

Using a quick action

To enter time spent, use the /spend quick action, followed by the time.

For example, if you need to log 1 month, 2 weeks, 3 days, 4 hours, and 5 minutes, type /spend 1mo 2w 3d 4h 5m. Check the time units you can use.

To add a time tracking report entry with a note, create a comment with a description and the quick action. It then shows in the time tracking report Summary/Notes column. For example:

Draft MR and respond to initial comments

/spend 30m

To log when time was spent, enter a date after the time, using the YYYY-MM-DD format.

For example, to log 1 hour of time spent on 31 January 2021, enter /spend 1h 2021-01-31.

If you type a future date, no time is logged.

Subtract time spent

Prerequisites:

  • You must have at least the Reporter role for the project.

To subtract time, enter a negative value. For example, /spend -3d removes three days from the total time spent. You can't go below 0 minutes of time spent, so if you remove more time than already entered, GitLab ignores the subtraction.

Delete time spent

A timelog is a single entry of time spent, either positive or negative.

Prerequisites:

  • You must be the author of the timelog or have at least the Maintainer role for the project.

To delete a timelog, either:

  • In the time tracking report, on the right of a timelog entry, select Delete time spent ({remove}).
  • Use the GraphQL API.

Delete all the time spent

Prerequisites:

  • You must have at least the Reporter role for the project.

To delete all the time spent at once, use the /remove_time_spent quick action.

View a time tracking report

Introduced in GitLab 13.12.

You can view a breakdown of time spent on an issue or merge request.

To view a time tracking report:

  1. Go to an issue or a merge request.
  2. In the right sidebar, select Time tracking report.

Time tracking report

The breakdown of spent time is limited to a maximum of 100 entries.

Available time units

The following time units are available:

Time unit What to type Conversion rate
Month mo, month, or months 4 w (160 h)
Week w, week, or weeks 5 d (40 h)
Day d, day, or days 8 h
Hour h, hour, or hours 60 m
Minute m, minute, or minutes

Limit displayed units to hours (FREE SELF)

Introduced in GitLab 12.1.

In GitLab self-managed instances, you can limit the display of time units to hours. To do so:

  1. On the left sidebar, expand the top-most chevron ({chevron-down}).
  2. Select Settings > Preferences.
  3. Expand Localization.
  4. Under Time tracking, select the Limit display of time tracking units to hours checkbox.
  5. Select Save changes.

With this option enabled, 75h is displayed instead of 1w 4d 3h.

Related topics