Commit 22757b20 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: add Trivy scan badges

parent 3bb7113a

README.md

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


| Input / Variable | Description                            | Default value     |

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

| `image` / `SPHINX_IMAGE` | The Docker image used to run Sphinx    | `ghcr.io/sphinx-doc/sphinx:latest` |

| `image` / `SPHINX_IMAGE` | The Docker image used to run Sphinx    | `ghcr.io/sphinx-doc/sphinx:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-SPHINX_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-SPHINX_IMAGE) |

| `project-dir` / `SPHINX_PROJECT_DIR` | Sphinx project root directory | `.` |

| `source-dir` / `SPHINX_SOURCE_DIR` | Sphinx source directory (relative to `$SPHINX_PROJECT_DIR`) containing the Sphinx `conf.py` file | `source` |

| `build-dir` / `SPHINX_BUILD_DIR` | Sphinx build directory (relative to `$SPHINX_PROJECT_DIR`), the path will be declared as artifact | `build` |
@@ -69,7 +69,7 @@ This job checks links with [lychee](https://github.com/lycheeverse/lychee). It u 
| Input / Variable | Description                                       | Default value     |

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

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

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

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

| `lychee-args` / `SPHINX_LYCHEE_ARGS` | [lychee arguments](https://github.com/lycheeverse/lychee#commandline-parameters) to execute | `--exclude-loopback $SPHINX_SOURCE_DIR/**/*.rst` |



## Publishing