Commit 8e7d5b45 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: add Trivy scan badges

parent ab3e8af9

{{cookiecutter.project_slug}}/README.md

+5 −5
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ The {{cookiecutter.template_name}} template uses some global configuration used 


| Input / Variable      | Description                            | Default value     |

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

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

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE` | The Docker image used to run `{{cookiecutter.cli_tool}}` | `docker.io/{{cookiecutter.project_slug}}:latest`<br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-{{cookiecutter.template_PREFIX}}_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-{{cookiecutter.template_PREFIX}}_IMAGE) |



## Jobs
@@ -93,7 +93,7 @@ It uses the following variables: 


| Input / Variable      | Description                                | Default value     |

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

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

| `lint-image` / `{{cookiecutter.template_PREFIX}}_LINT_IMAGE`      | The Docker image used to run the lint tool | `{{cookiecutter.project_slug}}-lint:latest`<br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-{{cookiecutter.template_PREFIX}}_LINT_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-{{cookiecutter.template_PREFIX}}_LINT_IMAGE) |

| `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` |
@@ -105,7 +105,7 @@ It uses the following variables: 


| Input / Variable      | Description                                | Default value     |

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

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

| `depcheck-image` / `{{cookiecutter.template_PREFIX}}_DEPCHECK_IMAGE`  | The Docker image used to run the dependency check tool | `{{cookiecutter.project_slug}}-depcheck:latest`<br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-{{cookiecutter.template_PREFIX}}_DEPCHECK_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-{{cookiecutter.template_PREFIX}}_DEPCHECK_IMAGE) |

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



### `{{cookiecutter.template_prefix}}-publish` job
@@ -365,7 +365,7 @@ The {{cookiecutter.template_name}} template uses some global configuration used 


| Input / Variable         | Description                            | Default value     |

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

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

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE`              | the Docker image used to run {{cookiecutter.template_name}} CLI commands | `docker.io/{{cookiecutter.project_slug}}:latest`<br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-{{cookiecutter.template_PREFIX}}_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-{{cookiecutter.template_PREFIX}}_IMAGE) |

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

| :lock: `{{cookiecutter.template_PREFIX}}_API_TOKEN`          | Default {{cookiecutter.template_name}} API token | _none_ |
@@ -485,7 +485,7 @@ It uses the following variable: 


| Input / Variable      | Description                              | Default value     |

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

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

| `image` / `{{cookiecutter.template_PREFIX}}_IMAGE`       | The Docker image used to run {{cookiecutter.template_name}}. | `docker.io/{{cookiecutter.project_slug}}:latest`<br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-{{cookiecutter.template_PREFIX}}_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-{{cookiecutter.template_PREFIX}}_IMAGE) |

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