debian-mirror-gitlab/doc/user/group/iterations/index.md

142 lines
5.9 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
type: reference
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
2020-06-23 00:09:42 +05:30
---
# Iterations **(STARTER)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/214713) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.1.
2020-07-28 23:09:34 +05:30
> - It was deployed behind a feature flag, disabled by default.
> - [Became enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/221047) on GitLab 13.2.
> - It's enabled on GitLab.com.
> - It's able to be enabled or disabled per-group.
> - It's recommended for production use.
2021-01-29 00:20:46 +05:30
> - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#disable-iterations). **(STARTER ONLY)**
2020-06-23 00:09:42 +05:30
Iterations are a way to track issues over a period of time. This allows teams
to track velocity and volatility metrics. Iterations can be used with [milestones](../../project/milestones/index.md)
for tracking over different time periods.
For example, you can use:
- Milestones for Program Increments, which span 8-12 weeks.
- Iterations for Sprints, which span 2 weeks.
In GitLab, iterations are similar to milestones, with a few differences:
- Iterations are only available to groups.
- A group can only have one active iteration at a time.
- Iterations require both a start and an end date.
- Iteration date ranges cannot overlap.
## View the iterations list
To view the iterations list, in a group, go to **{issues}** **Issues > Iterations**.
From there you can create a new iteration or click an iteration to get a more detailed view.
## Create an iteration
2021-02-22 17:27:13 +05:30
NOTE:
2020-07-28 23:09:34 +05:30
You need Developer [permissions](../../permissions.md) or higher to create an iteration.
2020-06-23 00:09:42 +05:30
To create an iteration:
1. In a group, go to **{issues}** **Issues > Iterations**.
1. Click **New iteration**.
1. Enter the title, a description (optional), a start date, and a due date.
1. Click **Create iteration**. The iteration details page opens.
2020-07-28 23:09:34 +05:30
## Edit an iteration
2020-06-23 00:09:42 +05:30
2021-01-29 00:20:46 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/218277) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.2.
2020-07-28 23:09:34 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2020-07-28 23:09:34 +05:30
You need Developer [permissions](../../permissions.md) or higher to edit an iteration.
To edit an iteration, click the three-dot menu (**{ellipsis_v}**) > **Edit iteration**.
2020-08-09 18:53:13 +05:30
## Add an issue to an iteration
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216158) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.2.
To learn how to add an issue to an iteration, see the steps in
2020-11-24 15:15:51 +05:30
[Managing issues](../../project/issues/managing_issues.md#add-an-issue-to-an-iteration).
2020-08-09 18:53:13 +05:30
2021-01-03 14:25:43 +05:30
## View an iteration report
> Viewing iteration reports in projects [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/222763) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.5.
You can track the progress of an iteration by reviewing iteration reports.
An iteration report displays a list of all the issues assigned to an iteration and their status.
2021-02-22 17:27:13 +05:30
The report also shows a breakdown of total issues in an iteration.
Open iteration reports show a summary of completed, unstarted, and in-progress issues.
Closed iteration reports show the total number of issues completed by the due date.
2021-01-03 14:25:43 +05:30
To view an iteration report, go to the iterations list page and click an iteration's title.
2021-01-29 00:20:46 +05:30
### Iteration burndown and burnup charts
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/222750) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.5.
2021-02-22 17:27:13 +05:30
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/269972) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.7.
2021-01-29 00:20:46 +05:30
The iteration report includes [burndown and burnup charts](../../project/milestones/burndown_and_burnup_charts.md),
similar to how they appear when viewing a [milestone](../../project/milestones/index.md).
Burndown charts help track completion progress of total scope, and burnup charts track the daily
total count and weight of issues added to and completed in a given timebox.
2021-03-08 18:12:59 +05:30
### Group issues by label
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/225500) in GitLab 13.8.
You can group the list of issues by label.
This can help you view issues that have your team's label,
and get a more accurate understanding of scope attributable to each label.
To group issues by label:
1. In the **Group by** dropdown, select **Label**.
1. Select the **Filter by label** dropdown.
1. Select the labels you want to group by in the labels dropdown.
You can also search for labels by typing in the search input.
1. Click or tap outside of the label dropdown. The page is now grouped by the selected labels.
2021-01-29 00:20:46 +05:30
## Disable iterations **(STARTER ONLY)**
2020-07-28 23:09:34 +05:30
GitLab Iterations feature is deployed with a feature flag that is **enabled by default**.
2020-06-23 00:09:42 +05:30
[GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md)
2020-07-28 23:09:34 +05:30
can disable it for your instance. `:group_iterations` can be enabled or disabled per-group.
2020-06-23 00:09:42 +05:30
To enable it:
```ruby
# Instance-wide
Feature.enable(:group_iterations)
# or by group
2020-11-24 15:15:51 +05:30
Feature.enable(:group_iterations, Group.find(<group ID>))
2020-06-23 00:09:42 +05:30
```
To disable it:
```ruby
# Instance-wide
Feature.disable(:group_iterations)
# or by group
2020-11-24 15:15:51 +05:30
Feature.disable(:group_iterations, Group.find(<group ID>))
2020-06-23 00:09:42 +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. -->