From 921d16124a626ad94e14bacb734033b0293ba431 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 14 Nov 2019 18:06:15 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/user/project/releases/index.md | 108 +++++++++++++++++++++++++++++++++---- 1 file changed, 97 insertions(+), 11 deletions(-) (limited to 'doc/user/project/releases/index.md') diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index 1ab348f57d4..d31df77f8a0 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -65,6 +65,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. @@ -85,17 +106,82 @@ 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 - -### New tag page with release notes text area - -![new_tag](img/new_tag.png) - -### Tags page with button to add or edit release notes for existing Git tag - -![tags](img/tags.png) +- 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": [] + } + ] + } +} +```