@@ -46,7 +46,7 @@ They shall adopt [snake_case](https://en.wikipedia.org/wiki/Snake_case) conventi
## Job prototype
Every template shall define define a ([hidden](https://docs.gitlab.com/ee/ci/yaml/#hide-jobs))
Every template shall define a ([hidden](https://docs.gitlab.com/ee/ci/yaml/#hide-jobs))
base job with name `.<prefix>-base`, [extended](https://docs.gitlab.com/ee/ci/yaml/#extends) by all other jobs,
that defines:
@@ -182,7 +182,7 @@ They shall implement the following jobs:
* must use the [`resource_group`](https://docs.gitlab.com/ee/ci/yaml/#resource_group) feature to prevent multiple
pipelines deploying to the same environment at the same time
* must propagate the `$CI_ENVIRONMENT_URL` variable as a `environment_url.txt` artifact file (legacy way)
* must propagate deployed environment information as [dotenv artifacts](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html#artifactsreportsdotenv)(the_dotenv_ way):
* must propagate deployed environment information as [dotenv artifacts](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdotenv)(the_dotenv_ way):
*`environment_type`: the type of environment (`review`, `integration`, `staging` or `production`),
*`environment_name`: the application name,
*`environment_url`: set to `$CI_ENVIRONMENT_URL`.
@@ -220,4 +220,4 @@ Those jobs should implement the following features:
* tests report integration using [JUnit test report](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsjunit)
* auto-evaluating the environment url to test based on the presence of `$environment_url` (possibly propagated by an upstream deployment template
using [dotenv artifacts](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html#artifactsreportsdotenv)) or a `environment_url.txt` file.
using [dotenv artifacts](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdotenv)) or a `environment_url.txt` file.
@@ -26,7 +26,7 @@ _to be continuous_ proposes a set of GitLab CI templates developed and maintaine
| Feature | Description |
| ------------------- | ----------- |
| [cache](https://docs.gitlab.com/ee/ci/caching/) | Every template carefully implements optimized cache policy to speedup your pipeline execution. |
| [artifacts](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html) | Every template implements optimized artifacts policy to keep only the bare necessities. |
| [artifacts](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html) | Every template implements optimized artifacts policy to keep only the bare necessities. |
| [interruptible](https://docs.gitlab.com/ee/ci/yaml/#interruptible) | Every interruptible job implements the `interruptible` feature to allow cancelling the pipeline as soon as a newer one is triggered. |
| [code coverage](https://docs.gitlab.com/ee/ci/testing/code_coverage.html) | Every build&test job enforces code coverage computing (using the required build tools and options), and integration to GitLab (visible in merge requests and as a [badge](https://docs.gitlab.com/ee/ci/testing/code_coverage.html#pipeline-badges)). |
| [JUnit test reports](https://docs.gitlab.com/ee/ci/testing/unit_test_reports.html) | Every test job produces - whenever possible - a JUnit report, so that your test reports are automatically integrated to your pipelines and merge requests. |
@@ -156,6 +156,8 @@ In that case there is a simple solution: simply encode it in [Base64](https://en
the variable value as the Base64 string prefixed with `@b64@`. This value **can** be masked, and it will be automatically
decoded by our templates (make sure you're using a version of the template that supports this syntax).
:warning: The Base64 string is not allowed to contain linebreaks. If you are for example using `base64` to encode, be sure to use the `-w 0` option to disable line wrapping.
!!! EXAMPLE
`CAVE_PASSPHRASE={"open":"$€5@me"}` can't be masked, but the Base64 encoded secret can.
