Commit e3a2c8eb authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

feat: migrate to CI/CD component 

⚠️ requires GitLab 16.6 or later
parent 35617e5a

{{cookiecutter.project_slug}}/README.md

+134 −55
Original line number Diff line number Diff line
@@ -4,22 +4,47 @@ This project implements a GitLab CI/CD template to build, test and analyse your 


## Usage



In order to include this template in your project, add the following to your `gitlab-ci.yml`:

This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component-in-a-cicd-configuration) 

or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.



### Use as a CI/CD component



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the component

  - component: gitlab.com/to-be-continuous/{{cookiecutter.project_slug}}/gitlab-ci-{{cookiecutter.project_slug}}@1.0.0

    # 2: set/override component inputs

    inputs:

      # ⚠ this is only an example

      build-args: "build --with-my-args"

```



### Use as a CI/CD template (legacy)



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the template

  - project: 'to-be-continuous/{{cookiecutter.project_slug}}'

    ref: '1.0.0'

    file: '/templates/gitlab-ci-{{cookiecutter.project_slug}}.yml'



variables:

  # 2: set/override template variables

  # ⚠ this is only an example

  {{cookiecutter.template_PREFIX}}_BUILD_ARGS: "build --with-my-args"

```



## Global configuration



The {{cookiecutter.template_name}} template uses some global configuration used throughout all jobs.



| Name                  | Description                            | Default value     |

| Input / Variable      | Description                            | Default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `{{cookiecutter.template_PREFIX}}_IMAGE` | The Docker image used to run `{{cookiecutter.cli_tool}}` | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE` | The Docker image used to run `{{cookiecutter.cli_tool}}` | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |



## Jobs
@@ -29,9 +54,9 @@ This job performs **build and tests** at once. 


It uses the following variable:



| Name                  | Description                              | Default value     |

| Input / Variable      | Description                              | Default value     |

| --------------------- | ---------------------------------------- | ----------------- |

| `{{cookiecutter.template_PREFIX}}_BUILD_ARGS`      | Arguments used by the build job          | `build --with-default-args` |

| `build-args` / `{{cookiecutter.template_PREFIX}}_BUILD_ARGS`      | Arguments used by the build job          | `build --with-default-args` |



### SonarQube analysis
@@ -66,11 +91,11 @@ This job performs a [lint](link-to-the-tool) analysis of your code, mapped to th 


It uses the following variables:



| Name                  | Description                                | Default value     |

| Input / Variable      | Description                                | Default value     |

| --------------------- | ------------------------------------------ | ----------------- |

| `{{cookiecutter.template_PREFIX}}_LINT_IMAGE`      | The Docker image used to run the lint tool | `{{cookiecutter.project_slug}}-lint:latest` |

| `{{cookiecutter.template_PREFIX}}_LINT_DISABLED`   | Set to `true` to disable the `lint` analysis| _none_ (enabled) |

| `{{cookiecutter.template_PREFIX}}_LINT_ARGS`       | Lint [options and arguments](link-to-the-cli-options) | `--serevity=medium` |

| `lint-image` / `{{cookiecutter.template_PREFIX}}_LINT_IMAGE`      | The Docker image used to run the lint tool | `{{cookiecutter.project_slug}}-lint:latest` |

| `lint-disabled` / `{{cookiecutter.template_PREFIX}}_LINT_DISABLED`   | Set to `true` to disable the `lint` analysis| _none_ (enabled) |

| `lint-args` / `{{cookiecutter.template_PREFIX}}_LINT_ARGS`       | Lint [options and arguments](link-to-the-cli-options) | `--serevity=medium` |



### `{{cookiecutter.template_prefix}}-depcheck` job
@@ -78,10 +103,10 @@ This job enables a manual [dependency check](link-to-the-tool) analysis of your 


It uses the following variables:



| Name                  | Description                                | Default value     |

| Input / Variable      | Description                                | Default value     |

| --------------------- | ------------------------------------------ | ----------------- |

| `{{cookiecutter.template_PREFIX}}_DEPCHECK_IMAGE`  | The Docker image used to run the dependency check tool | `{{cookiecutter.project_slug}}-depcheck:latest` |

| `{{cookiecutter.template_PREFIX}}_DEPCHECK_ARGS`   | Dependency check [options and arguments](link-to-the-cli-options) | _none_ |

| `depcheck-image` / `{{cookiecutter.template_PREFIX}}_DEPCHECK_IMAGE`  | The Docker image used to run the dependency check tool | `{{cookiecutter.project_slug}}-depcheck:latest` |

| `depcheck-args` / `{{cookiecutter.template_PREFIX}}_DEPCHECK_ARGS`   | Dependency check [options and arguments](link-to-the-cli-options) | _none_ |



### `{{cookiecutter.template_prefix}}-publish` job
@@ -89,10 +114,10 @@ This job is **disabled by default** and performs a publish of your built binarie 


It uses the following variables:



| Name                  | Description                            | Default value     |

| Input / Variable      | Description                            | Default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `{{cookiecutter.template_PREFIX}}_PUBLISH_ENABLED` | Variable to enable the publish job     | _none_ (disabled) |

| `{{cookiecutter.template_PREFIX}}_PUBLISH_ARGS`    | Arguments used by the publish job      | `publish --with-default-args` |

| `publish-enabled` / `{{cookiecutter.template_PREFIX}}_PUBLISH_ENABLED` | Variable to enable the publish job     | _none_ (disabled) |

| `publish-args` / `{{cookiecutter.template_PREFIX}}_PUBLISH_ARGS`    | Arguments used by the publish job      | `publish --with-default-args` |

| :lock: `{{cookiecutter.template_PREFIX}}_PUBLISH_LOGIN` | Login to use to publish           | **has to be defined** |

| :lock: `{{cookiecutter.template_PREFIX}}_PUBLISH_PASSWORD` | Password to use to publish     | **has to be defined** |
@@ -114,13 +139,44 @@ This project implements a GitLab CI/CD template to deploy your application to [{ 


## Usage



In order to include this template in your project, add the following to your `gitlab-ci.yml`:

This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component-in-a-cicd-configuration) 

or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.



### Use as a CI/CD component



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the component

  - component: gitlab.com/to-be-continuous/{{cookiecutter.project_slug}}/gitlab-ci-{{cookiecutter.project_slug}}@1.0.0

    # 2: set/override component inputs

    inputs:

      # ⚠ this is only an example

      base-app-name: wonderapp

      review-project: "prj-12345" # enable review env

      staging-project: "prj-12345" # enable staging env

      prod-project: "prj-12345" # enable production env

```



### Use as a CI/CD template (legacy)



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the template

  - project: 'to-be-continuous/{{cookiecutter.project_slug}}'

    ref: '1.0.0'

    file: '/templates/gitlab-ci-{{cookiecutter.project_slug}}.yml'



variables:

  # 2: set/override template variables

  # ⚠ this is only an example

  {{cookiecutter.template_PREFIX}}_BASE_APP_NAME: wonderapp

  {{cookiecutter.template_PREFIX}}_REVIEW_PROJECT: "prj-12345" # enable review env

  {{cookiecutter.template_PREFIX}}_STAGING_PROJECT: "prj-12345" # enable staging env

  {{cookiecutter.template_PREFIX}}_PROD_PROJECT: "prj-12345" # enable production env

```



## Understand
@@ -307,14 +363,14 @@ Here are some advices about your **secrets** (variables marked with a :lock:): 


The {{cookiecutter.template_name}} template uses some global configuration used throughout all jobs and environments.



| Name                     | Description                            | Default value     |

| Input / Variable         | Description                            | Default value     |

| ------------------------ | -------------------------------------- | ----------------- |

| `{{cookiecutter.template_PREFIX}}_IMAGE`              | the Docker image used to run {{cookiecutter.template_name}} CLI commands | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |

| `{{cookiecutter.template_PREFIX}}_BASE_APP_NAME`      | Base application name                  | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |

| `{{cookiecutter.template_PREFIX}}_API_URL`            | Default {{cookiecutter.template_name}} API url | _none_ |

| `{{cookiecutter.template_PREFIX}}_API_TOKEN`          | Default {{cookiecutter.template_name}} API token | _none_ |

| `{{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL`    | Default environments url _(only define for static environment URLs declaration)_<br/>_supports late variable expansion (ex: `https://%{environment_name}.{{cookiecutter.project_slug}}.acme.com`)_ | _none_ |

| `{{cookiecutter.template_PREFIX}}_SCRIPTS_DIR`        | Directory where deploy & cleanup scripts are located | `.` _(root project dir)_ |

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE`              | the Docker image used to run {{cookiecutter.template_name}} CLI commands | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |

| `base-app-name` / `{{cookiecutter.template_PREFIX}}_BASE_APP_NAME`      | Base application name                  | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |

| `api-url` / `{{cookiecutter.template_PREFIX}}_API_URL`            | Default {{cookiecutter.template_name}} API url | _none_ |

| `api-token` / `{{cookiecutter.template_PREFIX}}_API_TOKEN`          | Default {{cookiecutter.template_name}} API token | _none_ |

| `environment-url` / `{{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL`    | Default environments url _(only define for static environment URLs declaration)_<br/>_supports late variable expansion (ex: `https://%{environment_name}.{{cookiecutter.project_slug}}.acme.com`)_ | _none_ |

| `scripts-dir` / `{{cookiecutter.template_PREFIX}}_SCRIPTS_DIR`        | Directory where deploy & cleanup scripts are located | `.` _(root project dir)_ |



### Review environments configuration
@@ -325,14 +381,14 @@ They are **disabled by default** and can be enabled by setting the `{{cookiecutt 


Here are variables supported to configure review environments:



| Name                     | Description                            | Default value     |

| Input / Variable         | Description                            | Default value     |

| ------------------------ | -------------------------------------- | ----------------- |

| `{{cookiecutter.template_PREFIX}}_REVIEW_PROJECT`     | Project ID for `review` env | _none_ (disabled) |

| `{{cookiecutter.template_PREFIX}}_REVIEW_APP_NAME`    | Application name for `review` env      | `"{{ '${' }}{{cookiecutter.template_PREFIX}}_BASE_APP_NAME}-${CI_ENVIRONMENT_SLUG}"` (ex: `myproject-review-fix-bug-12`) |

| `{{cookiecutter.template_PREFIX}}_REVIEW_API_URL`     | API url for `review` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

| `{{cookiecutter.template_PREFIX}}_REVIEW_API_TOKEN`   | API token for `review` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_TOKEN` |

| `{{cookiecutter.template_PREFIX}}_REVIEW_ENVIRONMENT_URL`| The review environments url _(only define for static environment URLs declaration and if different from default)_ | `${{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL` |

| `{{cookiecutter.template_PREFIX}}_REVIEW_AUTOSTOP_DURATION`| The amount of time before GitLab will automatically stop `review` environments | `4 hours` |

| `review-project` / `{{cookiecutter.template_PREFIX}}_REVIEW_PROJECT`     | Project ID for `review` env | _none_ (disabled) |

| `review-app-name` / `{{cookiecutter.template_PREFIX}}_REVIEW_APP_NAME`    | Application name for `review` env      | `"{{ '${' }}{{cookiecutter.template_PREFIX}}_BASE_APP_NAME}-${CI_ENVIRONMENT_SLUG}"` (ex: `myproject-review-fix-bug-12`) |

| `review-api-url` / `{{cookiecutter.template_PREFIX}}_REVIEW_API_URL`     | API url for `review` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

| `review-api-token` / `{{cookiecutter.template_PREFIX}}_REVIEW_API_TOKEN`   | API token for `review` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_TOKEN` |

| `review-environment-url` / `{{cookiecutter.template_PREFIX}}_REVIEW_ENVIRONMENT_URL`| The review environments url _(only define for static environment URLs declaration and if different from default)_ | `${{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL` |

| `review-autostop-duration` / `{{cookiecutter.template_PREFIX}}_REVIEW_AUTOSTOP_DURATION`| The amount of time before GitLab will automatically stop `review` environments | `4 hours` |



### Integration environment configuration
@@ -342,13 +398,13 @@ It is **disabled by default** and can be enabled by setting the `{{cookiecutter. 


Here are variables supported to configure the integration environment:



| Name                     | Description                            | Default value     |

| Input / Variable         | Description                            | Default value     |

| ------------------------ | -------------------------------------- | ----------------- |

| `{{cookiecutter.template_PREFIX}}_INTEG_PROJECT`      | Project ID for `integration` env | _none_ (disabled) |

| `{{cookiecutter.template_PREFIX}}_INTEG_APP_NAME`     | Application name for `integration` env | `{{ '${' }}{{cookiecutter.template_PREFIX}}_BASE_APP_NAME}-integration` |

| `{{cookiecutter.template_PREFIX}}_INTEG_API_URL`      | API url for `integration` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

| `{{cookiecutter.template_PREFIX}}_INTEG_API_TOKEN`    | API token for `integration` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_TOKEN` |

| `{{cookiecutter.template_PREFIX}}_INTEG_ENVIRONMENT_URL`| The integration environment url _(only define for static environment URLs declaration and if different from default)_ | `${{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL` |

| `integ-project` / `{{cookiecutter.template_PREFIX}}_INTEG_PROJECT`      | Project ID for `integration` env | _none_ (disabled) |

| `integ-app-name` / `{{cookiecutter.template_PREFIX}}_INTEG_APP_NAME`     | Application name for `integration` env | `{{ '${' }}{{cookiecutter.template_PREFIX}}_BASE_APP_NAME}-integration` |

| `integ-api-url` / `{{cookiecutter.template_PREFIX}}_INTEG_API_URL`      | API url for `integration` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

| `integ-api-token` / `{{cookiecutter.template_PREFIX}}_INTEG_API_TOKEN`    | API token for `integration` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_TOKEN` |

| `integ-environment-url` / `{{cookiecutter.template_PREFIX}}_INTEG_ENVIRONMENT_URL`| The integration environment url _(only define for static environment URLs declaration and if different from default)_ | `${{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL` |



### Staging environment configuration
@@ -359,13 +415,13 @@ It is **disabled by default** and can be enabled by setting the `{{cookiecutter. 


Here are variables supported to configure the staging environment:



| Name                     | Description                            | Default value     |

| Input / Variable         | Description                            | Default value     |

| ------------------------ | -------------------------------------- | ----------------- |

| `{{cookiecutter.template_PREFIX}}_STAGING_PROJECT`    | Project ID for `staging` env | _none_ (disabled) |

| `{{cookiecutter.template_PREFIX}}_STAGING_APP_NAME`   | Application name for `staging` env     | `{{ '${' }}{{cookiecutter.template_PREFIX}}_BASE_APP_NAME}-staging` |

| `{{cookiecutter.template_PREFIX}}_STAGING_API_URL`    | API url for `staging` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

| `{{cookiecutter.template_PREFIX}}_STAGING_API_TOKEN`  | API token for `staging` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_TOKEN` |

| `{{cookiecutter.template_PREFIX}}_STAGING_ENVIRONMENT_URL`| The staging environment url _(only define for static environment URLs declaration and if different from default)_ | `${{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL` |

| `staging-project` / `{{cookiecutter.template_PREFIX}}_STAGING_PROJECT`    | Project ID for `staging` env | _none_ (disabled) |

| `staging-app-name` / `{{cookiecutter.template_PREFIX}}_STAGING_APP_NAME`   | Application name for `staging` env     | `{{ '${' }}{{cookiecutter.template_PREFIX}}_BASE_APP_NAME}-staging` |

| `staging-api-url` / `{{cookiecutter.template_PREFIX}}_STAGING_API_URL`    | API url for `staging` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

| `staging-api-token` / `{{cookiecutter.template_PREFIX}}_STAGING_API_TOKEN`  | API token for `staging` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_TOKEN` |

| `staging-environment-url` / `{{cookiecutter.template_PREFIX}}_STAGING_ENVIRONMENT_URL`| The staging environment url _(only define for static environment URLs declaration and if different from default)_ | `${{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL` |



### Production environment configuration
@@ -375,27 +431,50 @@ It is **disabled by default** and can be enabled by setting the `{{cookiecutter. 


Here are variables supported to configure the production environment:



| Name                      | Description                            | Default value     |

| Input / Variable          | Description                            | Default value     |

| ------------------------- | -------------------------------------- | ----------------- |

| `{{cookiecutter.template_PREFIX}}_PROD_PROJECT`        | Project ID for `production` env | _none_ (disabled) |

| `{{cookiecutter.template_PREFIX}}_PROD_APP_NAME`       | Application name for `production` env  | `${{cookiecutter.template_PREFIX}}_BASE_APP_NAME` |

| `{{cookiecutter.template_PREFIX}}_PROD_API_URL`        | API url for `production` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

| `{{cookiecutter.template_PREFIX}}_PROD_API_TOKEN`      | API token for `production` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_TOKEN` |

| `{{cookiecutter.template_PREFIX}}_PROD_ENVIRONMENT_URL`| The production environment url _(only define for static environment URLs declaration and if different from default)_ | `${{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL` |

| `{{cookiecutter.template_PREFIX}}_PROD_DEPLOY_STRATEGY`| Defines the deployment to production strategy. One of `manual` (i.e. _one-click_) or `auto`. | `manual` |

| `prod-project` / `{{cookiecutter.template_PREFIX}}_PROD_PROJECT`        | Project ID for `production` env | _none_ (disabled) |

| `prod-app-name` / `{{cookiecutter.template_PREFIX}}_PROD_APP_NAME`       | Application name for `production` env  | `${{cookiecutter.template_PREFIX}}_BASE_APP_NAME` |

| `prod-api-url` / `{{cookiecutter.template_PREFIX}}_PROD_API_URL`        | API url for `production` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

| `prod-api-token` / `{{cookiecutter.template_PREFIX}}_PROD_API_TOKEN`      | API token for `production` env _(only define to override default)_ | `${{cookiecutter.template_PREFIX}}_API_TOKEN` |

| `prod-environment-url` / `{{cookiecutter.template_PREFIX}}_PROD_ENVIRONMENT_URL`| The production environment url _(only define for static environment URLs declaration and if different from default)_ | `${{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL` |

| `prod-deploy-strategy` / `{{cookiecutter.template_PREFIX}}_PROD_DEPLOY_STRATEGY`| Defines the deployment to production strategy. One of `manual` (i.e. _one-click_) or `auto`. | `manual` |



{%- elif cookiecutter.template_type == 'acceptance' %}

This project implements a GitLab CI/CD template to run your automated tests with [{{cookiecutter.template_name}}]({{cookiecutter.refdoc_url}}).



## Usage



In order to include this template in your project, add the following to your `gitlab-ci.yml`:

This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component-in-a-cicd-configuration) 

or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.



### Use as a CI/CD component



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the component

  - component: gitlab.com/to-be-continuous/{{cookiecutter.project_slug}}/gitlab-ci-{{cookiecutter.project_slug}}@1.0.0

    # 2: set/override component inputs

    inputs:

      review-enabled: true # ⚠ this is only an example

```



### Use as a CI/CD template (legacy)



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the template

  - project: 'to-be-continuous/{{cookiecutter.project_slug}}'

    ref: '1.0.0'

    file: '/templates/gitlab-ci-{{cookiecutter.project_slug}}.yml'



variables:

  # 2: set/override template variables

  REVIEW_ENABLED: "true" # ⚠ this is only an example

```



## `{{cookiecutter.project_slug}}` job
@@ -404,12 +483,12 @@ This job starts [{{cookiecutter.template_name}}]({{cookiecutter.refdoc_url}}) (f 


It uses the following variable:



| Name                  | Description                              | Default value     |

| Input / Variable      | Description                              | Default value     |

| --------------------- | ---------------------------------------- | ----------------- |

| `{{cookiecutter.template_PREFIX}}_IMAGE`       | The Docker image used to run {{cookiecutter.template_name}}. | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |

| `{{cookiecutter.template_PREFIX}}_PROJECT_DIR` | The {{cookiecutter.template_name}} project directory (containing test scripts) | `.` |

| `{{cookiecutter.template_PREFIX}}_EXTRA_ARGS`  | {{cookiecutter.template_name}} extra [run options](link-to-cli-options-ref) | _none_ |

| `REVIEW_ENABLED`      | Set to `true` to enable {{cookiecutter.template_name}} tests on review environments (dynamic environments instantiated on development branches) | _none_ (disabled) |

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE`       | The Docker image used to run {{cookiecutter.template_name}}. | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |

| `project-dir` / `{{cookiecutter.template_PREFIX}}_PROJECT_DIR` | The {{cookiecutter.template_name}} project directory (containing test scripts) | `.` |

| `extra-args` / `{{cookiecutter.template_PREFIX}}_EXTRA_ARGS`  | {{cookiecutter.template_name}} extra [run options](link-to-cli-options-ref) | _none_ |

| `review-enabled` / `REVIEW_ENABLED`      | Set to `true` to enable {{cookiecutter.template_name}} tests on review environments (dynamic environments instantiated on development branches) | _none_ (disabled) |



In addition to a textual report in the console, this job produces the following reports, kept for one day:

{{cookiecutter.project_slug}}/kicker.json

+8 −2
Original line number Diff line number Diff line
@@ -4,6 +4,8 @@ 
  "description": "Build, test and verify your [{{cookiecutter.template_name}}]({{cookiecutter.refdoc_url}}) projects",

  "template_path": "templates/gitlab-ci-{{cookiecutter.project_slug}}.yml",

  "kind": "build",

  "prefix": "{{cookiecutter.template_prefix}}",

  "is_component": true,

  "variables": [

    {

      "name": "{{cookiecutter.template_PREFIX}}_IMAGE",
@@ -86,10 +88,12 @@ 
  "description": "Deploy your application to [{{cookiecutter.template_name}}]({{cookiecutter.refdoc_url}})",

  "template_path": "templates/gitlab-ci-{{cookiecutter.project_slug}}.yml",

  "kind": "hosting",

  "prefix": "{{cookiecutter.template_prefix}}",

  "is_component": true,

  "variables": [

    {

      "name": "{{cookiecutter.template_PREFIX}}_IMAGE",

      "description": "the Docker image used to run {{cookiecutter.template_name}} CLI commands - **set the version required by your {{cookiecutter.template_name}} cluster**",

      "description": "The Docker image used to run {{cookiecutter.template_name}} CLI commands - **set the version required by your {{cookiecutter.template_name}} cluster**",

      "default": "registry.hub.docker.com/{{cookiecutter.project_slug}}:latest"

    },

    {
@@ -111,7 +115,7 @@ 
    {

      "name": "{{cookiecutter.template_PREFIX}}_ENVIRONMENT_URL",

      "type": "url",

      "description": "The default environments url _(only define for static environment URLs declaration)_\n\n_supports late variable expansion (ex: `https://%{environment_name}.k8s.acme.com`)_"

      "description": "The default environments url _(only define for static environment URLs declaration)_\n\n_supports late variable expansion (ex: `https://%{environment_name}.{{cookiecutter.template_prefix}}.acme.com`)_"

    },

    {

      "name": "{{cookiecutter.template_PREFIX}}_SCRIPTS_DIR",
@@ -277,6 +281,8 @@ 
  "description": "Run your automated tests with [{{cookiecutter.template_name}}]({{cookiecutter.refdoc_url}})",

  "template_path": "templates/gitlab-ci-{{cookiecutter.project_slug}}.yml",

  "kind": "acceptance",

  "prefix": "{{cookiecutter.template_prefix}}",

  "is_component": true,

  "variables": [

    {

      "name": "{{cookiecutter.template_PREFIX}}_IMAGE",

{{cookiecutter.project_slug}}/templates/gitlab-ci-{{cookiecutter.project_slug}}.yml

+126 −2

File changed.

Preview size limit exceeded, changes collapsed.