diff options
Diffstat (limited to 'doc/user/project/releases')
-rw-r--r-- | doc/user/project/releases/img/edit_release_page_v12_5.png | bin | 0 -> 150927 bytes | |||
-rw-r--r-- | doc/user/project/releases/img/milestone_list_with_releases_v12_5.png | bin | 0 -> 45454 bytes | |||
-rw-r--r-- | doc/user/project/releases/img/milestone_with_releases_v12_5.png | bin | 0 -> 67529 bytes | |||
-rw-r--r-- | doc/user/project/releases/img/new_tag_12_5.png | bin | 0 -> 42439 bytes | |||
-rw-r--r-- | doc/user/project/releases/img/release_edit_button_v12_5.png | bin | 0 -> 87472 bytes | |||
-rw-r--r-- | doc/user/project/releases/img/release_with_milestone_v12_5.png | bin | 0 -> 20197 bytes | |||
-rw-r--r-- | doc/user/project/releases/img/tags_12_5.png | bin | 0 -> 44666 bytes | |||
-rw-r--r-- | doc/user/project/releases/index.md | 131 |
8 files changed, 131 insertions, 0 deletions
diff --git a/doc/user/project/releases/img/edit_release_page_v12_5.png b/doc/user/project/releases/img/edit_release_page_v12_5.png Binary files differnew file mode 100644 index 00000000000..8b9c502a2ef --- /dev/null +++ b/doc/user/project/releases/img/edit_release_page_v12_5.png diff --git a/doc/user/project/releases/img/milestone_list_with_releases_v12_5.png b/doc/user/project/releases/img/milestone_list_with_releases_v12_5.png Binary files differnew file mode 100644 index 00000000000..2e3ec08ba87 --- /dev/null +++ b/doc/user/project/releases/img/milestone_list_with_releases_v12_5.png diff --git a/doc/user/project/releases/img/milestone_with_releases_v12_5.png b/doc/user/project/releases/img/milestone_with_releases_v12_5.png Binary files differnew file mode 100644 index 00000000000..8719a58ce4e --- /dev/null +++ b/doc/user/project/releases/img/milestone_with_releases_v12_5.png diff --git a/doc/user/project/releases/img/new_tag_12_5.png b/doc/user/project/releases/img/new_tag_12_5.png Binary files differnew file mode 100644 index 00000000000..6137ad2ee56 --- /dev/null +++ b/doc/user/project/releases/img/new_tag_12_5.png diff --git a/doc/user/project/releases/img/release_edit_button_v12_5.png b/doc/user/project/releases/img/release_edit_button_v12_5.png Binary files differnew file mode 100644 index 00000000000..f60b0ecb1be --- /dev/null +++ b/doc/user/project/releases/img/release_edit_button_v12_5.png diff --git a/doc/user/project/releases/img/release_with_milestone_v12_5.png b/doc/user/project/releases/img/release_with_milestone_v12_5.png Binary files differnew file mode 100644 index 00000000000..2a7a2ee9754 --- /dev/null +++ b/doc/user/project/releases/img/release_with_milestone_v12_5.png diff --git a/doc/user/project/releases/img/tags_12_5.png b/doc/user/project/releases/img/tags_12_5.png Binary files differnew file mode 100644 index 00000000000..4c032f96125 --- /dev/null +++ b/doc/user/project/releases/img/tags_12_5.png diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index ceb077ab8af..8372aefc94c 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -58,6 +58,31 @@ links from your GitLab instance. NOTE: **NOTE** You can manipulate links of each release entry with [Release Links API](../../../api/releases/links.md) +#### Releases associated with milestones + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/29020) in GitLab 12.5. + +Releases can optionally be associated with one or more +[project milestones](../milestones/index.md#project-milestones-and-group-milestones) +by including a `milestones` array in your requests to the +[Releases API](../../../api/releases/index.md#create-a-release). + +Releases display this association with the **Milestone** indicator near +the top of the Release block on the **Project overview > Releases** page. + +![A Release with one associated milestone](img/release_with_milestone_v12_5.png) + +Below is an example of milestones with no Releases, one Release, and two +Releases, respectively. + +![Milestones with and without Release associations](img/milestone_list_with_releases_v12_5.png) + +This relationship is also visible in the **Releases** section of the sidebar +when viewing a specific milestone. Below is an example of a milestone +associated with a large number of Releases. + +![Milestone with lots of associated Releases](img/milestone_with_releases_v12_5.png) + ## Releases list Navigate to **Project > Releases** in order to see the list of releases for a given @@ -65,6 +90,27 @@ project. ![Releases list](img/releases.png) +## Editing a release + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/26016) in GitLab 12.5. + +To edit the details of a release, navigate to **Project overview > Releases** and click +the edit button (pencil icon) in the top-right corner of the release you want to modify. + +![A release with an edit button](img/release_edit_button_v12_5.png) + +This will bring you to the **Edit Release** page, from which you can +change some of the release's details. + +![Edit release page](img/edit_release_page_v12_5.png) + +Currently, it is only possible to edit the release title and notes. +To change other release information, such as its tag, associated +milestones, or release date, use the +[Releases API](../../../api/releases/index.md#update-a-release). Editing this +information through the **Edit Release** page is planned for a future version +of GitLab. + ## Notification for Releases > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/26001) in GitLab 12.4. @@ -77,6 +123,91 @@ following modal window will be then displayed, from which you can select **New r ![Custom notification - New release](img/custom_notifications_new_release_v12_4.png) +## Add release notes to Git tags + +You can add release notes to any Git tag using the notes feature. Release notes +behave like any other markdown form in GitLab so you can write text and +drag and drop files to it. Release notes are stored in GitLab's database. + +There are several ways to add release notes: + +- In the interface, when you create a new Git tag. +- In the interface, by adding a note to an existing Git tag. +- Using the GitLab API. + +To create a new tag, navigate to your project's **Repository > Tags** and +click **New tag**. From there, you can fill the form with all the information +about the release: + +![new_tag](img/new_tag_12_5.png "Creation of a new tag.") + +You can also edit an existing tag to add release notes: + +![tags](img/tags_12_5.png "Addition of note to an existing tag") + +## Release Evidence + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/26019) in GitLab 12.5. + +Each time a new release is created, specific related data is collected in +parallel. This dataset will be a snapshot this new release (including linked +milestones and issues) at moment of creation. Such collection of data will +provide a chain of custody and facilitate processes like external audits, for example. + +The gathered Evidence data is stored in the database upon creation of a new +release as a JSON object. In GitLab 12.5, a link to +the Evidence data is provided for [each Release](#releases-list). + +Here's what this object can look like: + +```json +{ + "release": { + "id": 5, + "tag": "v4.0", + "name": "New release", + "project_id": 45, + "project_name": "Project name", + "released_at": "2019-06-28 13:23:40 UTC", + "milestones": [ + { + "id": 11, + "title": "v4.0-rc1", + "state": "closed", + "due_date": "2019-05-12 12:00:00 UTC", + "created_at": "2019-04-17 15:45:12 UTC", + "issues": [ + { + "id": 82, + "title": "The top-right popup is broken", + "author_name": "John Doe", + "author_email": "john@doe.com", + "state": "closed", + "due_date": "2019-05-10 12:00:00 UTC" + }, + { + "id": 89, + "title": "The title of this page is misleading", + "author_name": "Jane Smith", + "author_email": "jane@smith.com", + "state": "closed", + "due_date": "nil" + } + ] + }, + { + "id": 12, + "title": "v4.0-rc2", + "state": "closed", + "due_date": "2019-05-30 18:30:00 UTC", + "created_at": "2019-04-17 15:45:12 UTC", + "issues": [] + } + ] + } +} +``` + <!-- ## Troubleshooting Include any troubleshooting steps that you can foresee. If you know beforehand what issues |