Commit 83bd734d authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: add Trivy scan badges

parent 96343387

README.md

+2 −2
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ The MkDocs template uses some global configuration used throughout all jobs. 


| Input / Variable | Description                            | Default value     |

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

| `image` / `MKD_IMAGE` | The Docker image used to run MkDocs    | `docker.io/squidfunk/mkdocs-material:latest` |

| `image` / `MKD_IMAGE` | The Docker image used to run MkDocs    | `docker.io/squidfunk/mkdocs-material:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-MKD_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-MKD_IMAGE) |

| `workspace-dir` / `MKD_WORKSPACE_DIR` | MkDocs sources directory | `.` |

| `requirements-file` / `MKD_REQUIREMENTS_FILE` | Requirements file. If the file is not found in the repository, requirements are read from the `MKD_REQUIREMENTS` variable | `requirements.txt` |

| `requirements` / `MKD_REQUIREMENTS` | Space separated requirements (ignored if a requirement file is found) | `mkdocs` |
@@ -71,7 +71,7 @@ This job checks links with [lychee](https://github.com/lycheeverse/lychee). It u 
| Input / Variable | Description                                       | Default value     |

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

| `lychee-enabled` / `MKD_LYCHEE_ENABLED` | Set to `true` to enable this job                  | _none_ (disabled) |

| `lychee-image` / `MKD_LYCHEE_IMAGE` | The Docker image used to run [lychee](https://github.com/lycheeverse/lychee) | `docker.io/lycheeverse/lychee:latest` |

| `lychee-image` / `MKD_LYCHEE_IMAGE` | The Docker image used to run [lychee](https://github.com/lycheeverse/lychee) | `docker.io/lycheeverse/lychee:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-MKD_LYCHEE_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-MKD_LYCHEE_IMAGE) |

| `lychee-args` / `MKD_LYCHEE_ARGS` | [lychee arguments](https://github.com/lycheeverse/lychee#commandline-parameters) to execute | `docs/` |



## Publishing