summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean McGivern <sean@gitlab.com>2017-03-30 09:26:42 +0100
committerSean McGivern <sean@gitlab.com>2017-03-30 09:26:42 +0100
commitb22da792e96318c3486887203180c13386e90bc0 (patch)
tree09d05113cf198415653a16675bfd7f76038185b1
parentf618d47964acc03af8c4e9f9c0295db4a95eed77 (diff)
downloadgitlab-shell-b22da792e96318c3486887203180c13386e90bc0.tar.gz
Explain when to use a v in version number
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index dba278e..f30df06 100644
--- a/README.md
+++ b/README.md
@@ -137,11 +137,18 @@ Starting with GitLab 8.12, GitLab supports Git LFS authentication through ssh.
GitLab Shell is versioned by git tags, and the version used by the Rails
application is stored in
[`GITLAB_SHELL_VERSION`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/GITLAB_SHELL_VERSION).
+
+For each version, there is a raw version and a tag version:
+
+- The **raw version** is the version number. For instance, `15.2.8`.
+- The **tag version** is the raw version prefixed with `v`. For instance, `v15.2.8`.
+
To release a new version of GitLab Shell and have that version available to the
Rails application:
-1. Update the [`CHANGELOG`](CHANGELOG) and [`VERSION`](VERSION) files.
-2. Add a new git tag.
-3. Update `GITLAB_SHELL_VERSION` in the Rails application. (Note: this can be
- done as a separate MR to that, or in and MR that will make use of the latest
- GitLab Shell changes.)
+1. Update the [`CHANGELOG`](CHANGELOG) with the **tag version** and the
+ [`VERSION`](VERSION) file with the **raw version**.
+2. Add a new git tag with the **tag version**.
+3. Update `GITLAB_SHELL_VERSION` in the Rails application to the **raw
+ version**. (Note: this can be done as a separate MR to that, or in and MR
+ that will make use of the latest GitLab Shell changes.)