From 9eb705b9381acca4cbeb1328a32b370cbade0f3e Mon Sep 17 00:00:00 2001 From: Tyler Ward Date: Tue, 5 Feb 2019 15:30:03 -0800 Subject: [PATCH] #841 - document `environment_variables.git_sha` --- docs/using_lagoon/lagoon_yml.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/using_lagoon/lagoon_yml.md b/docs/using_lagoon/lagoon_yml.md index c46979f874..d061ab634f 100644 --- a/docs/using_lagoon/lagoon_yml.md +++ b/docs/using_lagoon/lagoon_yml.md @@ -14,6 +14,9 @@ The `.lagoon.yml` file must be placed at the root of your git repository. ``` docker-compose-yaml: docker-compose.yml +environment_variables: + git_sha: 'true' + tasks: pre-rollout: - run: @@ -77,6 +80,9 @@ This allows you to define the behaviour of the automatic creates routes (NOT the * `Redirect` will redirect any http requests to https * `None` will mean a route for http will _not_ be created, and no redirect +### `environment_variables.git_sha` +This setting allows you to enable injecting the deployed git SHA into your project as an environment variable. By default this is disabled, setting the value to `true` then sets the SHA as the environment variable `LAGOON_GIT_SHA`. + ## Tasks There are different type of tasks you can define, they differ when exactly they are executed in a build flow: