Commit 0a891463 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent 98f06cd9

README.md

+4 −4
Original line number Diff line number Diff line
@@ -70,7 +70,7 @@ repository configuration without any specific configuration.** 


The sbt template uses some global configuration used throughout all jobs.



| Name           | description                                                                                               | default value                                                                                                                                     |

| Name           | Description                                                                                               | Default value                                                                                                                                     |

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

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

| `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` |
@@ -92,7 +92,7 @@ for test jobs dependency reasons (some test jobs such as SONAR analysis have a d 


It uses the following environment variable:



| Name             | description                                 | default value                     |

| Name             | Description                                 | Default value                     |

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

| `SBT_BUILD_ARGS` | sbt arguments for the [build job packaging](https://www.scala-sbt.org/1.x/docs/Running.html#Common+commands)   | `clean package`                   |

| `SBT_TEST_ARGS`  | sbt arguments for the [build job test phase](https://www.scala-sbt.org/1.x/docs/Running.html#Common+commands) | `coverage test coverageAggregate` |
@@ -120,7 +120,7 @@ This job generates a [SBOM](https://cyclonedx.org/) file listing all dependencie 


It is bound to the `test` stage, and uses the following variables:



| Name                  | description                            | default value     |

| Name                  | Description                            | Default value     |

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

| `SBT_SBOM_DISABLED` | Set to `true` to disable this job | _none_ |

| `SBT_SBOM_IMAGE` | The syft image used for SBOM analysis | `registry.hub.docker.com/anchore/syft:debug` |
@@ -165,7 +165,7 @@ Example: 


Define the following environment variables :



| name                                    | description                                       |

| Name                                    | Description                                       |

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

| `MAVEN_REPOSITORY_PUBLISH_SNAPSHOT_URL` | Destination repository to publish snpashot artifacts |

| `MAVEN_REPOSITORY_PUBLISH_RELEASE_URL`  | Destination repository to publish release artifacts |