Commit bdc9ae90 authored by Amy Qualls's avatar Amy Qualls

Merge branch 'nfriend-update-docs-for-new-release-page' into 'master'

Add documentation about New Release page

See merge request gitlab-org/gitlab!38944
parents ec22b7b4 02fa566b
...@@ -53,25 +53,26 @@ Read more about [Release permissions](../../../user/permissions.md#project-membe ...@@ -53,25 +53,26 @@ Read more about [Release permissions](../../../user/permissions.md#project-membe
You can create a release in the user interface, or by using the You can create a release in the user interface, or by using the
[Releases API](../../../api/releases/index.md#create-a-release). [Releases API](../../../api/releases/index.md#create-a-release).
We recommend using the API to add release notes as one of the last steps in your CI/CD release pipeline. We recommend using the API to create releases as one of the last steps in your
CI/CD pipeline.
To create a new release through the GitLab UI: To create a new release through the GitLab UI:
1. Navigate to **Project overview > Releases** and click the **New release** button. 1. Navigate to **Project overview > Releases** and click the **New release**
button.
1. In the [**Tag name**](#tag-name) box, enter a name. 1. In the [**Tag name**](#tag-name) box, enter a name.
1. In the **Create from** list, select the branch or enter a tag or commit SHA.
1. In the **Message** box, enter a message associated with the tag.
1. Optionally, in the [**Release notes**](#release-notes-description)
field, enter the release's description. You can use Markdown and drag and drop files to this field.
- If you leave this field empty, only a tag will be created.
- If you populate it, both a tag and a release will be created.
1. Click **Create tag**.
If you created a release, you can view it at **Project overview > Releases**. NOTE: **Note:**
If you created a tag, you can view it at **Repository > Tags**. Creating a release based on an existing tag using the user
interface is not yet supported. However, this is possible using the
[Releases API](../../../api/releases/index.md#create-a-release).
You can now edit the release to [add milestones](#associate-milestones-with-a-release) 1. In the **Create from** list, select a branch, tag, or commit SHA to use when
and [release assets](#release-assets). creating the new tag.
1. Optionally, fill out any additional information about the release, such as its
[title](#title), [milestones](#associate-milestones-with-a-release),
[release notes](#release-notes-description), or [assets links](#links).
1. Click **Create release**.
### Schedule a future release ### Schedule a future release
...@@ -218,6 +219,21 @@ For more information, see [Deployment safety](../../../ci/environments/deploymen ...@@ -218,6 +219,21 @@ For more information, see [Deployment safety](../../../ci/environments/deploymen
The following fields are available when you create or edit a release. The following fields are available when you create or edit a release.
### Title
The release title can be customized using the **Release title** field when
creating or editing a release. If no title is provided, the release's tag name
will be used instead.
NOTE: **Note:**
Guest users of private projects are allowed to view the **Releases** page
but are _not_ allowed to view details about the Git repository (in particular,
tag names). Because of this, release titles will be replaced with a generic
title like "Release-1234" for Guest users to avoid leaking tag name information.
See the [Permissions](../../permissions.md#project-members-permissions) page for
more information about permissions.
### Tag name ### Tag name
The release tag name should include the release version. GitLab uses [Semantic Versioning](https://semver.org/) The release tag name should include the release version. GitLab uses [Semantic Versioning](https://semver.org/)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment