Commit 6bf54770 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: add Trivy scan badges

parent 80727c70

README.md

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


| Input / Variable | Description                                                                                               | Default value                                                                                                                                     |

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

| `image` / `SBT_IMAGE` | The Docker image used to run sbt <br/>:warning: **set the version required by your project**              | `registry.hub.docker.com/sbtscala/scala-sbt:17.0.2_1.6.2_3.1.3`                                                                                                           |

| `image` / `SBT_IMAGE` | The Docker image used to run sbt <br/>:warning: **set the version required by your project**              | `registry.hub.docker.com/sbtscala/scala-sbt:17.0.2_1.6.2_3.1.3`                                                                                                           <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-SBT_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-SBT_IMAGE) |

| `opts` / `SBT_OPTS` | Global [sbt options](https://www.scala-sbt.org/1.x/docs/Command-Line-Reference.html#sbt+JVM+options+and+system+properties) | `-Dsbt.global.base=sbt-cache/sbtboot -Dsbt.boot.directory=sbt-cache/boot -Dsbt.coursier.home=sbt-cache/coursier -Dsbt.ci=true -Dsbt.color=always` |

| `cli-opts` / `SBT_CLI_OPTS` | Additional sbt options used on the command line                                                           | `--batch`                                                                                                                                         |
@@ -147,7 +147,7 @@ It is bound to the `test` stage, and uses the following variables: 
| --------------------- | -------------------------------------- | ----------------- |

| `sbom-disabled` / `SBT_SBOM_DISABLED` | Set to `true` to disable this job | _none_ |

| `TBC_SBOM_MODE`                       | Controls when SBOM reports are generated (`onrelease`: only on `$INTEG_REF`, `$PROD_REF` and `$RELEASE_REF` pipelines; `always`: any pipeline).<br/>:warning: `sbom-disabled` / `SBT_SBOM_DISABLED` takes precedence | `onrelease` |

| `sbom-image` / `SBT_SBOM_IMAGE` | The syft image used for SBOM analysis | `registry.hub.docker.com/anchore/syft:debug` |

| `sbom-image` / `SBT_SBOM_IMAGE` | The syft image used for SBOM analysis | `registry.hub.docker.com/anchore/syft:debug` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-SBT_SBOM_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-SBT_SBOM_IMAGE) |

| `sbom-opts` / `SBT_SBOM_OPTS` | Options for syft used for SBOM analysis | `dir:sbt-cache/coursier --catalogers java-cataloger` |



In addition to logs in the console, this job produces the following reports, kept for one week: