diff options
Diffstat (limited to 'doc/user/project/releases/index.md')
| -rw-r--r-- | doc/user/project/releases/index.md | 37 |
1 files changed, 25 insertions, 12 deletions
diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index 06ad71713d7..1ea21b1f269 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -86,7 +86,7 @@ by using a `release` node in the job definition. The release is created only if the job processes without error. If the Rails API returns an error during release creation, the release job fails. -### Schedule a future release +### Upcoming releases > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/38105) in GitLab 12.1. @@ -271,10 +271,15 @@ Release note descriptions are unrelated. Description supports [Markdown](../../m ### Release assets -You can add the following types of assets to each release: +A release contains the following types of assets: - [Source code](#source-code) -- [Links](#links) +- [Permanent links to release assets](#permanent-links-to-release-assets) + +#### Source code + +GitLab automatically generates `zip`, `tar.gz`, `tar.bz2`, and `tar` +archived source code from the given Git tag. These are read-only assets. #### Permanent links to release assets @@ -285,9 +290,21 @@ GitLab always redirects this URL to the actual asset location, so even if the assets move to a different location, you can continue to use the same URL. This is defined during [link creation](../../../api/releases/links.md#create-a-link) or [updating](../../../api/releases/links.md#update-a-link). -Each asset has a name, a URL of the *actual* asset location, and optionally, a -`filepath` parameter, which, if you specify it, creates a URL pointing -to the asset for the Release. The format of the URL is: +Each asset has a `name`, a `url` of the *actual* asset location, and optionally, +`filepath` and `link_type` parameters. + +A `filepath` creates a URL pointing to the asset for the Release. + +The `link_type` parameter accepts one of the following four values: + +- `runbook` +- `package` +- `image` +- `other` (default) + +This field has no effect on the URL and it's only used for visual purposes in the Releases page of your project. + +The format of the URL is: ```plaintext https://host/namespace/project/releases/:release/downloads/:filepath @@ -300,7 +317,8 @@ namespace and `gitlab-runner` project on `gitlab.com`, for example: { "name": "linux amd64", "filepath": "/binaries/gitlab-runner-linux-amd64", - "url": "https://gitlab-runner-downloads.s3.amazonaws.com/v11.9.0-rc2/binaries/gitlab-runner-linux-amd64" + "url": "https://gitlab-runner-downloads.s3.amazonaws.com/v11.9.0-rc2/binaries/gitlab-runner-linux-amd64", + "link_type": "other" } ``` @@ -312,11 +330,6 @@ https://gitlab.com/gitlab-org/gitlab-runner/releases/v11.9.0-rc2/downloads/binar The physical location of the asset can change at any time and the direct link remains unchanged. -### Source code - -GitLab automatically generates `zip`, `tar.gz`, `tar.bz2` and `tar` -archived source code from the given Git tag. These are read-only assets. - ### Links A link is any URL which can point to whatever you like: documentation, built |