debian-mirror-gitlab/doc/user/project/milestones/index.md

243 lines
9.5 KiB
Markdown
Raw Normal View History

2019-10-12 21:52:04 +05:30
---
type: index, reference
2020-06-23 00:09:42 +05:30
stage: Plan
group: Project Management
2021-02-22 17:27:13 +05:30
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/#assignments
2019-10-12 21:52:04 +05:30
---
2021-03-11 19:13:27 +05:30
# Milestones **(FREE)**
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
Milestones in GitLab are a way to track issues and merge requests created to achieve a broader goal in a certain period of time.
Milestones allow you to organize issues and merge requests into a cohesive group, with an optional start date and an optional due date.
2019-02-15 15:39:39 +05:30
## Milestones as releases
2022-07-23 23:45:48 +05:30
Milestones can be used to track releases. To do so:
2019-12-26 22:10:19 +05:30
1. Set the milestone due date to represent the release date of your release and leave the milestone start date blank.
1. Set the milestone title to the version of your release, such as `Version 9.4`.
1. Add an issue to your release by associating the desired milestone from the issue's right-hand sidebar.
2021-02-22 17:27:13 +05:30
Additionally, you can integrate milestones with the [Releases feature](../releases/index.md#associate-milestones-with-a-release).
2019-02-15 15:39:39 +05:30
2018-03-17 18:26:18 +05:30
## Project milestones and group milestones
2022-08-13 15:12:31 +05:30
A milestone can belong to [project](../index.md) or [group](../../group/index.md).
2020-07-28 23:09:34 +05:30
2022-08-13 15:12:31 +05:30
You can assign **project milestones** to issues or merge requests in that project only.
2020-07-28 23:09:34 +05:30
You can assign **group milestones** to any issue or merge request of any project in that group.
For information about project and group milestones API, see:
- [Project Milestones API](../../../api/milestones.md)
- [Group Milestones API](../../../api/group_milestones.md)
2022-08-13 15:12:31 +05:30
### View project or group milestones
To view the milestone list:
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project or
**Main menu > Groups** and find your group.
2022-08-13 15:12:31 +05:30
1. Select **Issues > Milestones**.
In a project, GitLab displays milestones that belong to the project.
In a group, GitLab displays milestones that belong to the group and all projects in the group.
2022-10-11 01:57:18 +05:30
### View milestones in a project with issues turned off
2022-08-27 11:52:29 +05:30
If a project has issue tracking
[turned off](../settings/index.md#configure-project-visibility-features-and-permissions),
you can get to the milestones page
2022-10-11 01:57:18 +05:30
by going to its URL.
To do so:
1. Go to your project.
1. Add: `/-/milestones` to your project URL.
For example `https://gitlab.com/gitlab-org/sample-data-templates/sample-gitlab-project/-/milestones`.
Alternatively, this project's issues are visible in the group's milestone page.
Improving this experience is tracked in issue [339009](https://gitlab.com/gitlab-org/gitlab/-/issues/339009).
2022-08-27 11:52:29 +05:30
2022-08-13 15:12:31 +05:30
### View all milestones
2018-03-17 18:26:18 +05:30
2022-08-13 15:12:31 +05:30
You can view all the milestones you have access to in the entire GitLab namespace.
You might not see some milestones because they're in projects or groups you're not a member of.
2022-10-11 01:57:18 +05:30
To do so, on the top bar select **Main menu > Milestones**.
### View milestone details
To view more information about a milestone,
in the milestone list select the title of the milestone you want to view.
The milestone view shows the title and description.
There are also tabs below these that show the following:
- **Issues**: Shows all issues assigned to the milestone. These are displayed in three columns named:
- Unstarted Issues (open and unassigned)
- Ongoing Issues (open and assigned)
- Completed Issues (closed)
- **Merge Requests**: Shows all merge requests assigned to the milestone. These are displayed in four columns named:
- Work in progress (open and unassigned)
- Waiting for merge (open and assigned)
- Rejected (closed)
- Merged
- **Participants**: Shows all assignees of issues assigned to the milestone.
- **Labels**: Shows all labels that are used in issues assigned to the milestone.
#### Burndown charts
The milestone view contains a [burndown and burnup chart](burndown_and_burnup_charts.md),
showing the progress of completing a milestone.
![burndown chart](img/burndown_and_burnup_charts_v15_3.png)
#### Milestone sidebar
The milestone sidebar on the milestone view shows the following:
- Percentage complete, which is calculated as number of closed issues divided by total number of issues.
- The start date and due date.
- The total time spent on all issues and merge requests assigned to the milestone.
- The total issue weight of all issues assigned to the milestone.
![Project milestone page](img/milestones_project_milestone_page_sidebar_v13_11.png)
2022-08-13 15:12:31 +05:30
## Create a milestone
2017-08-17 22:00:37 +05:30
2022-07-16 23:28:13 +05:30
> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
2017-08-17 22:00:37 +05:30
2022-08-13 15:12:31 +05:30
You can create a milestone either in a project or a group.
2017-08-17 22:00:37 +05:30
2022-07-16 23:28:13 +05:30
Prerequisites:
2022-08-13 15:12:31 +05:30
- You must have at least the Reporter role for the project or group the milestone belongs to.
2022-07-16 23:28:13 +05:30
2022-04-04 11:22:00 +05:30
To create a milestone:
2020-07-28 23:09:34 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project or **Main menu > Groups** and find your group.
2022-04-04 11:22:00 +05:30
1. On the left sidebar, select **Issues > Milestones**.
2021-06-08 01:23:25 +05:30
1. Select **New milestone**.
2022-08-13 15:12:31 +05:30
1. Enter the title.
1. Optional. Enter description, start date, and due date.
2021-06-08 01:23:25 +05:30
1. Select **New milestone**.
2018-03-17 18:26:18 +05:30
2022-04-04 11:22:00 +05:30
![New milestone](img/milestones_new_project_milestone.png)
2018-03-17 18:26:18 +05:30
2022-08-13 15:12:31 +05:30
## Edit a milestone
2017-08-17 22:00:37 +05:30
2022-07-16 23:28:13 +05:30
> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
Prerequisites:
2022-08-13 15:12:31 +05:30
- You must have at least the Reporter role for the project or group the milestone belongs to.
2020-07-28 23:09:34 +05:30
To edit a milestone:
2018-03-17 18:26:18 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project or **Main menu > Groups** and find your group.
2021-06-08 01:23:25 +05:30
1. Select a milestone's title.
1. Select **Edit**.
2022-08-13 15:12:31 +05:30
1. Edit the title, start date, due date, or description.
1. Select **Save changes**.
## Delete a milestone
> [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/343889) the minimum user role from Developer to Reporter in GitLab 15.0.
2018-03-17 18:26:18 +05:30
2022-08-13 15:12:31 +05:30
Prerequisites:
- You must have at least the Reporter role for the project or group the milestone belongs to.
To edit a milestone:
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project or **Main menu > Groups** and find your group.
2022-08-13 15:12:31 +05:30
1. Select a milestone's title.
1. Select **Delete**.
1. Select **Delete milestone**.
2018-03-17 18:26:18 +05:30
2022-08-13 15:12:31 +05:30
## Promote a project milestone to a group milestone
2018-03-17 18:26:18 +05:30
2021-02-22 17:27:13 +05:30
If you are expanding the number of projects in a group, you might want to share the same milestones
2022-08-13 15:12:31 +05:30
among this group's projects. You can also promote project milestones to group milestones to
2021-02-22 17:27:13 +05:30
make them available to other projects in the same group.
2018-03-17 18:26:18 +05:30
2022-08-13 15:12:31 +05:30
Promoting a milestone merges all project milestones across all projects in this group with the same
name into a single group milestone.
All issues and merge requests that were previously assigned to one of these project
milestones become assigned to the new group milestone.
2018-03-17 18:26:18 +05:30
2021-02-22 17:27:13 +05:30
WARNING:
2022-08-13 15:12:31 +05:30
This action cannot be reversed and the changes are permanent.
Prerequisites:
- You must have at least the Reporter role for the group.
To promote a project milestone:
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Projects** and find your project.
2022-08-13 15:12:31 +05:30
1. Either:
- Select **Promote to Group Milestone** (**{level-up}**).
- Select the milestone title, and then select **Promote**.
1. Select **Promote Milestone**.
## Assign a milestone to an issue or merge request
Every issue and merge request can be assigned one milestone.
The milestones are visible on every issue and merge request page, on the right sidebar.
They are also visible in the issue board.
2018-03-17 18:26:18 +05:30
2022-08-13 15:12:31 +05:30
To assign or unassign a milestone:
2018-03-17 18:26:18 +05:30
2022-08-13 15:12:31 +05:30
1. View an issue or a merge request.
1. On the right sidebar, next to **Milestones**, select **Edit**.
1. In the **Assign milestone** list, search for a milestone by typing its name.
You can select from both project and group milestones.
1. Select the milestone you want to assign.
2018-03-17 18:26:18 +05:30
2022-08-13 15:12:31 +05:30
You can also use the `/assign` [quick action](../quick_actions.md) in a comment.
2018-03-17 18:26:18 +05:30
2022-10-11 01:57:18 +05:30
## Filter issues and merge requests by milestone
2018-03-17 18:26:18 +05:30
2022-10-11 01:57:18 +05:30
### Filters in list pages
2018-03-17 18:26:18 +05:30
2022-07-23 23:45:48 +05:30
From the project and group issue/merge request list pages, you can filter by both group and project milestones.
2018-03-17 18:26:18 +05:30
2022-10-11 01:57:18 +05:30
### Filters in issue boards
2018-03-17 18:26:18 +05:30
2021-03-11 19:13:27 +05:30
From [project issue boards](../issue_board.md), you can filter by both group milestones and project
milestones in:
2022-07-23 23:45:48 +05:30
- [Search and filter bar](../issue_board.md#filter-issues)
2021-03-11 19:13:27 +05:30
- [Issue board configuration](../issue_board.md#configurable-issue-boards)
From [group issue boards](../issue_board.md#group-issue-boards), you can filter by only group milestones in:
2022-07-23 23:45:48 +05:30
- [Search and filter bar](../issue_board.md#filter-issues)
2021-03-11 19:13:27 +05:30
- [Issue board configuration](../issue_board.md#configurable-issue-boards)
2018-03-17 18:26:18 +05:30
### Special milestone filters
When filtering by milestone, in addition to choosing a specific project milestone or group milestone, you can choose a special milestone filter.
2018-12-13 13:39:08 +05:30
- **None**: Show issues or merge requests with no assigned milestone.
- **Any**: Show issues or merge requests that have an assigned milestone.
2021-02-22 17:27:13 +05:30
- **Upcoming**: Show issues or merge requests that have been assigned the open milestone and has the nearest due date in the future.
2019-07-07 11:18:12 +05:30
- **Started**: Show issues or merge requests that have an open assigned milestone with a start date that is before today.
2017-08-17 22:00:37 +05:30
2019-10-12 21:52:04 +05:30
<!-- ## 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. -->