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

docs: homogenize inherited variables doc

parent 160ad368

{{cookiecutter.project_slug}}/README.md

+8 −8
Original line number Diff line number Diff line
@@ -329,8 +329,8 @@ Here are variables supported to configure review environments: 
| ------------------------ | -------------------------------------- | ----------------- |

| `{{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 if different from default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

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

| `{{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` |
@@ -346,8 +346,8 @@ Here are variables supported to configure the integration environment: 
| ------------------------ | -------------------------------------- | ----------------- |

| `{{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 if different from default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

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

| `{{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` |



### Staging environment configuration
@@ -363,8 +363,8 @@ Here are variables supported to configure the staging environment: 
| ------------------------ | -------------------------------------- | ----------------- |

| `{{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 if different from default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

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

| `{{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` |



### Production environment configuration
@@ -379,8 +379,8 @@ Here are variables supported to configure the production environment: 
| ------------------------- | -------------------------------------- | ----------------- |

| `{{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 if different from default)_ | `${{cookiecutter.template_PREFIX}}_API_URL` |

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

| `{{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` |

{{cookiecutter.project_slug}}/kicker.json

+12 −12
Original line number Diff line number Diff line
@@ -133,7 +133,7 @@ 
        },

        {

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

          "description": "The application name for `review` env (only define if different from global)",

          "description": "The application name for `review` env (only define to override default)",

          "advanced": true

        },

        {
@@ -150,12 +150,12 @@ 
        {

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

          "type": "url",

          "description": "API url for `review` env _(only define if different from default)_",

          "description": "API url for `review` env _(only define to override default)_",

          "advanced": true

        },

        {

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

          "description": "API token for `review` env (only define if different from default)",

          "description": "API token for `review` env (only define to override default)",

          "secret": true

        }

      ]
@@ -172,7 +172,7 @@ 
        },

        {

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

          "description": "The application name for `integration` env (only define if different from global)",

          "description": "The application name for `integration` env (only define to override default)",

          "advanced": true

        },

        {
@@ -184,12 +184,12 @@ 
        {

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

          "type": "url",

          "description": "API url for `integration` env _(only define if different from default)_",

          "description": "API url for `integration` env _(only define to override default)_",

          "advanced": true

        },

        {

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

          "description": "API token for `integration` env (only define if different from default)",

          "description": "API token for `integration` env (only define to override default)",

          "secret": true

        }

      ]
@@ -206,7 +206,7 @@ 
        },

        {

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

          "description": "The application name for `staging` env (only define if different from global)",

          "description": "The application name for `staging` env (only define to override default)",

          "advanced": true

        },

        {
@@ -218,12 +218,12 @@ 
        {

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

          "type": "url",

          "description": "API url for `staging` env _(only define if different from default)_",

          "description": "API url for `staging` env _(only define to override default)_",

          "advanced": true

        },

        {

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

          "description": "API token for `staging` env (only define if different from default)",

          "description": "API token for `staging` env (only define to override default)",

          "secret": true

        }

      ]
@@ -240,7 +240,7 @@ 
        },

        {

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

          "description": "The application name for `production` env (only define if different from global)",

          "description": "The application name for `production` env (only define to override default)",

          "advanced": true

        },

        {
@@ -259,12 +259,12 @@ 
        {

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

          "type": "url",

          "description": "API url for `production` env _(only define if different from default)_",

          "description": "API url for `production` env _(only define to override default)_",

          "advanced": true

        },

        {

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

          "description": "API token for `production` env (only define if different from default)",

          "description": "API token for `production` env (only define to override default)",

          "secret": true

        }

      ]