summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormo khan <mo.khan@gmail.com>2019-10-16 15:16:05 -0600
committermo khan <mo.khan@gmail.com>2019-10-17 13:37:44 -0600
commit8799e669cc709181f2162b0c7a8b6e68f39e6693 (patch)
treeb02af965850a1967f7693e12f2d6c3714c3f95f1 /README.md
parent3bbac84b46cf8419fb7a6f0304217ad810a842b2 (diff)
Add documentation on how to release new versions
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8712ad5..ec7918f 100644
--- a/README.md
+++ b/README.md
@@ -106,6 +106,23 @@ to the docker command.
## Versioning and release process
+1. Create a new entry in the `.gitlab-ci.yml` file for the new version to release.
+
+ ```yaml
+ 12-x-stable:
+ extends: .release
+ variables:
+ DOTENV: ".env.12-x-stable"
+ ```
+
+2. Create a new `.env.*` that corresponds to the version to release and specify the default configuration.
+
+ ```text
+ FEATURE_RUBY_REPORT 'true'
+ LM_REPORT_VERSION '2.0'
+ LM_V1_CANONICALIZE 'true'
+ ```
+
Please check the [Release Process documentation](https://gitlab.com/gitlab-org/security-products/release/blob/master/docs/release_process.md).
# Contributing