Commit 70ef2abe authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent 555bd488

README.md

+7 −7
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ include: 


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



| Name                    | description                                                                                                                                                                            | default value             |

| Name                    | Description                                                                                                                                                                            | Default value             |

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

| `GRADLE_IMAGE`          | The Docker image used to run Gradle <br/>:warning: **set the version required by your project**                                                                                        | `registry.hub.docker.com/library/gradle:latest`           |

| `GRADLE_CLI_OPTS`       | Additional Gradle options used on the command line                                                                                                                                     | `None`                    |
@@ -64,7 +64,7 @@ for test jobs dependency reasons. 


It uses the following variable:



| Name                   | description                               | default value     |

| Name                   | Description                               | Default value     |

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

| `GRADLE_BUILD_ARGS`    | Gradle arguments for the build & test job | `build`           |
@@ -100,7 +100,7 @@ By adding the plugin, the template will automatically add `jacocoTestReport` and 


The jacoco coverage display in gitlab uses the following variable



| Name                       | description                                         | default value          |

| Name                       | Description                                         | Default value          |

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

| `JACOCO_CSV_REPORT`    | Name of report                                          | `jacocoTestReport.csv` |
@@ -110,7 +110,7 @@ This job is **disabled by default** and performs a SonarQube analysis of your co 


The job is bound to the `test` stage and uses the following variables:



| Name                     | description                            | default value     |

| Name                     | Description                            | Default value     |

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

| `SONAR_HOST_URL`         | SonarQube server url                   | _none_ (disabled) |

| :lock: `SONAR_TOKEN`     | SonarQube authentication [token](https://docs.sonarqube.org/latest/user-guide/user-token/) | _none_ |
@@ -123,7 +123,7 @@ The Gradle template features a job `gradle-dependency-check` that performs a man 


It is bound to the `test` stage and use the following variable :



| Name                          | description                                   | default value          |

| Name                          | Description                                   | Default value          |

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

| `GRADLE_DEPENDENCY_CHECK_DISABLED` | Set to `true` to disable this job        | _none_ (enabled) |

| `GRADLE_DEPENDENCY_CHECK_TASK` | Name of the gradle task launching the analysis | `dependencyCheckAnalyze` |
@@ -243,7 +243,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     |

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

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

| `GRADLE_SBOM_VERSION` | Version of the `cyclonedx-gradle-plugin` used for SBOM analysis<br/>_When unset, the latest version will be used_ | _none_ |
@@ -265,7 +265,7 @@ Currently the pipeline exposes two __manual__ jobs of publication: 


Both jobs use the following variables



| Name                       | description                                                             | default value     |

| Name                       | Description                                                             | Default value     |

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

| `GRADLE_PUBLISH_VERSION`   | The value is propagated as gradle properties named `version`. It should be used in your publish task | `${CI_COMMIT_REF_SLUG}-SNAPSHOT` |

| `GRADLE_PUBLISH_ARGS`      | The publish task that is invoked                                        | `publish`         |