diff options
author | Marcia Ramos <marcia@gitlab.com> | 2019-01-07 15:18:41 +0000 |
---|---|---|
committer | Marcia Ramos <marcia@gitlab.com> | 2019-01-07 15:18:41 +0000 |
commit | d8cdf81285b93bae0327ee92772ddc5aca036dfa (patch) | |
tree | 1dc411c056e23bad299e184d79911a7a681cbd93 /doc | |
parent | 5774ffe063296432d4dd564e444c671d27b86596 (diff) | |
download | gitlab-ce-d8cdf81285b93bae0327ee92772ddc5aca036dfa.tar.gz |
Update Releases documentation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/releases.md | 2 | ||||
-rw-r--r-- | doc/user/project/index.md | 15 | ||||
-rw-r--r-- | doc/user/project/releases.md | 60 | ||||
-rw-r--r-- | doc/user/project/releases/img/releases.png (renamed from doc/user/project/img/releases.png) | bin | 126093 -> 126093 bytes | |||
-rw-r--r-- | doc/user/project/releases/index.md | 59 | ||||
-rw-r--r-- | doc/workflow/releases.md | 15 |
6 files changed, 78 insertions, 73 deletions
diff --git a/doc/api/releases.md b/doc/api/releases.md index bfd0cc1c4ea..4613fe3482a 100644 --- a/doc/api/releases.md +++ b/doc/api/releases.md @@ -1,7 +1,7 @@ # Releases API > - [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41766) in GitLab 11.7. -> - Using this API you can manipulate GitLab's [Release](../user/project/releases.md) entries. +> - Using this API you can manipulate GitLab's [Release](../user/project/releases/index.md) entries. ## List Releases diff --git a/doc/user/project/index.md b/doc/user/project/index.md index e63ed88249d..d46ae31580a 100644 --- a/doc/user/project/index.md +++ b/doc/user/project/index.md @@ -72,12 +72,15 @@ website with GitLab Pages **Other features:** -- [Wiki](wiki/index.md): Document your GitLab project in an integrated Wiki -- [Snippets](../snippets.md): Store, share and collaborate on code snippets -- [Cycle Analytics](cycle_analytics.md): Review your development lifecycle -- [Syntax highlighting](highlighting.md): An alternative to customize -your code blocks, overriding GitLab's default choice of language -- [Badges](badges.md): Badges for the project overview +- [Wiki](wiki/index.md): document your GitLab project in an integrated Wiki. +- [Snippets](../snippets.md): store, share and collaborate on code snippets. +- [Cycle Analytics](cycle_analytics.md): review your development lifecycle. +- [Syntax highlighting](highlighting.md): an alternative to customize +your code blocks, overriding GitLab's default choice of language. +- [Badges](badges.md): badges for the project overview. +- [Releases](releases/index.md): a way to track deliverables in your project as snapshot in time of +the source, build output, and other metadata or artifacts +associated with a released version of your code. ### Project's integrations diff --git a/doc/user/project/releases.md b/doc/user/project/releases.md index 3f3525829b8..737842962a9 100644 --- a/doc/user/project/releases.md +++ b/doc/user/project/releases.md @@ -1,59 +1 @@ -# Releases - -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41766) in GitLab 11.7. - -It's typical to create a [Git tag](../../university/training/topics/tags.md) at -the moment of release to introduce a checkpoint in your source code -history, but in most cases your users will need compiled objects or other -assets output by your CI system to use them, not just the raw source -code. - -GitLab's **Releases** are a way to track deliverables in your project. Consider them -a snapshot in time of the source, build output, and other metadata or artifacts -associated with a released version of your code. - -At the moment, you can create Release entries via the [Releases API](../../api/releases.md); -we recommend doing this as one of the last steps in your CI/CD release pipeline. - -## Getting started with Releases - -Start by giving a [description](#release-description) to the Release and -including its [assets](#release-assets), as follows. - -### Release description - -Every Release has a description. You can add any text you like, but we recommend -including a changelog to describe the content of your release. This will allow -your users to quickly scan the differences between each one you publish. - -NOTE: **Note:** -[Git's tagging messages](https://git-scm.com/book/en/v2/Git-Basics-Tagging) and -Release descriptions are unrelated. Description supports [markdown](../markdown.md). - -### Release assets - -You can currently add the following types of assets to each Release: - -- [Source code](#source-code): state of the repo at the time of the Release -- [Links](#links): to content such as built binaries or documentation - -GitLab will support more asset types in the future, including objects such -as pre-built packages, compliance/security evidence, or container images. - -#### Source code - -GitLab automatically generate `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 -binaries, or other related materials. These can be both internal or external -links from your GitLab instance. - -## Releases list - -Navigate to **Project > Releases** in order to see the list of releases for a given -project. - -![Releases list](img/releases.png) +This document was moved to [another location](releases/index.md). diff --git a/doc/user/project/img/releases.png b/doc/user/project/releases/img/releases.png Binary files differindex f8b1b7305ad..f8b1b7305ad 100644 --- a/doc/user/project/img/releases.png +++ b/doc/user/project/releases/img/releases.png diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md new file mode 100644 index 00000000000..890d6fbc6c7 --- /dev/null +++ b/doc/user/project/releases/index.md @@ -0,0 +1,59 @@ +# Releases + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41766) in GitLab 11.7. + +It's typical to create a [Git tag](../../../university/training/topics/tags.md) at +the moment of release to introduce a checkpoint in your source code +history, but in most cases your users will need compiled objects or other +assets output by your CI system to use them, not just the raw source +code. + +GitLab's **Releases** are a way to track deliverables in your project. Consider them +a snapshot in time of the source, build output, and other metadata or artifacts +associated with a released version of your code. + +At the moment, you can create Release entries via the [Releases API](../../../api/releases.md); +we recommend doing this as one of the last steps in your CI/CD release pipeline. + +## Getting started with Releases + +Start by giving a [description](#release-description) to the Release and +including its [assets](#release-assets), as follows. + +### Release description + +Every Release has a description. You can add any text you like, but we recommend +including a changelog to describe the content of your release. This will allow +your users to quickly scan the differences between each one you publish. + +NOTE: **Note:** +[Git's tagging messages](https://git-scm.com/book/en/v2/Git-Basics-Tagging) and +Release descriptions are unrelated. Description supports [markdown](../../markdown.md). + +### Release assets + +You can currently add the following types of assets to each Release: + +- [Source code](#source-code): state of the repo at the time of the Release +- [Links](#links): to content such as built binaries or documentation + +GitLab will support more asset types in the future, including objects such +as pre-built packages, compliance/security evidence, or container images. + +#### Source code + +GitLab automatically generate `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 +binaries, or other related materials. These can be both internal or external +links from your GitLab instance. + +## Releases list + +Navigate to **Project > Releases** in order to see the list of releases for a given +project. + +![Releases list](img/releases.png) diff --git a/doc/workflow/releases.md b/doc/workflow/releases.md index 02388bb73ea..aa0d2a7f799 100644 --- a/doc/workflow/releases.md +++ b/doc/workflow/releases.md @@ -1,16 +1,17 @@ # Releases -NOTE: In GitLab 11.7, we introduced the full fledged [releases](../user/project/releases.md) feature. You can still create release notes on this page, but the new method is preferred. +NOTE: In GitLab 11.7, we introduced the full fledged [Releases](../user/project/releases/index.md) +feature. You can still create release notes on this page, but the new method is preferred. -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 +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-n-drop files to it. Release notes are stored in GitLab's database. -There are several ways to add release notes: +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 +- 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 |