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

docs: normalise table headers

parent 927dc9c5

{{cookiecutter.project_slug}}/README.md

+11 −11
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ include: 


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



| Name                  | description                            | default value     |

| Name                  | Description                            | Default value     |

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

| `{{cookiecutter.template_PREFIX}}_IMAGE` | The Docker image used to run `{{cookiecutter.cli_tool}}` | `registry.hub.docker.com/{{cookiecutter.project_slug}}:latest` |
@@ -31,7 +31,7 @@ This job performs **build and tests** at once. 


It uses the following variable:



| Name                  | description                              | default value     |

| Name                  | Description                              | Default value     |

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

| `{{cookiecutter.template_PREFIX}}_BUILD_ARGS`      | Arguments used by the build job          | `build --with-default-args` |
@@ -68,7 +68,7 @@ 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     |

| Name                  | 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) |
@@ -80,7 +80,7 @@ This job enables a manual [dependency check](link-to-the-tool) analysis of your 


It uses the following variables:



| Name                  | description                                | default value     |

| Name                  | 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_ |
@@ -91,7 +91,7 @@ This job is **disabled by default** and performs a publish of your built binarie 


It uses the following variables:



| Name                  | description                            | default value     |

| Name                  | 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` |
@@ -309,7 +309,7 @@ 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     |

| Name                     | 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)) |
@@ -327,7 +327,7 @@ 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     |

| Name                     | 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`) |
@@ -344,7 +344,7 @@ 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     |

| Name                     | 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` |
@@ -361,7 +361,7 @@ 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     |

| Name                     | 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` |
@@ -377,7 +377,7 @@ 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     |

| Name                      | 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` |
@@ -406,7 +406,7 @@ This job starts [{{cookiecutter.template_name}}]({{cookiecutter.refdoc_url}}) (f 


It uses the following variable:



| Name                  | description                              | default value     |

| Name                  | 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) | `.` |