diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-09-28 11:07:41 +0200 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-09-28 11:07:41 +0200 |
| commit | 44d1560db4bdf678e9c98dfcddbef3180b2aaf8e (patch) | |
| tree | 4314d23c2f158ab90a34f9d356eab377a35e3556 /doc/user/project/cycle_analytics.md | |
| parent | 3b206ccb8393d8f2c5ad227874d9a60beb054782 (diff) | |
| download | gitlab-ce-44d1560db4bdf678e9c98dfcddbef3180b2aaf8e.tar.gz | |
Clarify the Plan to Code stages in Cycle Analytics docs
[ci skip]
Diffstat (limited to 'doc/user/project/cycle_analytics.md')
| -rw-r--r-- | doc/user/project/cycle_analytics.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/user/project/cycle_analytics.md b/doc/user/project/cycle_analytics.md index abef80e7914..84231f879bf 100644 --- a/doc/user/project/cycle_analytics.md +++ b/doc/user/project/cycle_analytics.md @@ -28,9 +28,10 @@ You can see that there are seven stages in total: (first assignment, any milestone, milestone date or assignee is not required) - **Plan** (Board) - Median time from giving an issue a milestone or label until pushing the - first commit + first commit to the branch - **Code** (IDE) - - Median time from the first commit until the merge request is created + - Median time from the first commit to the branch until the merge request is + created - **Test** (CI) - Median total test time for all commits/merges - **Review** (Merge Request/MR) @@ -57,7 +58,7 @@ Below you can see in more detail what the various stages of Cycle Analytics mean | **Stage** | **Description** | | --------- | --------------- | | Issue | Measures the median time between creating an issue and taking action to solve it, by either labeling it or adding it to a milestone, whatever comes first. The label will be tracked only if it already has an [Issue Board list][board] created for it. | -| Plan | Measures the median time between the action you took for the previous stage, and pushing the first commit to the repository. To make this change tracked, the pushed commit needs to contain the [issue closing pattern], for example `Closes #xxx`, where `xxx` is the number of the issue related to this commit. If the commit does not contain the issue closing pattern, it is not considered to the measurement time of the stage. | +| Plan | Measures the median time between the action you took for the previous stage, and pushing the first commit to the branch. The very first commit is the one that triggers the separation between **Plan** and **Code** and at least one commit needs to contain the [issue closing pattern] in order to know what branch and commit is related to the issue (for example, `Closes #xxx`, where `xxx` is the number of the issue related to this commit). The closing pattern doesn't necessarily need to be in the first commit message. If there is no commit containing the issue closing pattern, it is not considered to the measurement time of the stage. | | Code | Measures the median time between pushing a first commit (previous stage) and creating a merge request related to that commit. The key to keep the process tracked is include the [issue closing pattern] to the description of the merge request. | | Test | Measures the median time to run the entire pipeline for that project. It's related to the time GitLab CI takes to run every job for the commits pushed to that merge request defined in the previous stage. It is basically the start->finish time for all pipelines. `master` is not excluded. It does not attempt to track time for any particular stages. | | Review | Measures the median time taken to review the merge request, between its creation and until it's merged. | |