Commit 5d99fb7a authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent fd148964

README.md

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


The Node.js template uses some global configuration used throughout all jobs.



| Name                   | description                                                                                      | default value     |

| Name                   | Description                                                                                      | Default value     |

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

| `NODE_IMAGE`           | The Docker image used to run Node.js <br/>:warning: **set the version required by your project** | `registry.hub.docker.com/library/node:lts-alpine` |

| `NODE_MANAGER`         | The package manager used by your project (npm or yarn)<br/>**If undefined, automatic detection** | _none_            |
@@ -70,7 +70,7 @@ The Node template features a job `node-lint` that performs Node.js source code * 


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



| Name                     | description                                                                                                                                                                                                                | default value                 |

| Name                     | Description                                                                                                                                                                                                                | Default value                 |

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

| `NODE_LINT_ENABLED`      | Set to `true` to enable lint analysis                                                                                                                                                                                      | _none_ (disabled)             |

| `NODE_LINT_ARGS`         | npm [run script](https://docs.npmjs.com/cli/v8/commands/npm-run-script) arguments to execute the lint analysis <br/> yarn [run script](https://classic.yarnpkg.com/en/docs/cli/run) arguments to execute the lint analysis | `run lint`                    |
@@ -86,7 +86,7 @@ for jobs dependency reasons (some jobs such as SONAR analysis have a dependency 


This job is bound to the `build` stage, and uses the following variables:



| Name                          | description                                                                                                                                                       | default value         |

| Name                          | Description                                                                                                                                                       | Default value         |

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

| `NODE_BUILD_DISABLED`         | Set to `true` to disable build                                                                                                                                    | _none_ (enabled)      |

| `NODE_BUILD_DIR`              | Variable to define build directory                                                                                                                                | `dist`                |
@@ -301,7 +301,7 @@ The Node template features a job `node-audit` that performs an audit ([npm audit 


It is bound to the `test` stage.



| Name                   | description                                                                                                                                           | default value                    |

| Name                   | Description                                                                                                                                           | Default value                    |

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

| `NODE_AUDIT_DISABLED`  | Set to `true` to disable npm audit                                                                                                                    | _none_ (enabled)                 |

| `NODE_AUDIT_ARGS`      | npm [audit](https://docs.npmjs.com/cli/v8/commands/npm-audit) arguments <br/> yarn [audit](https://classic.yarnpkg.com/en/docs/cli/audit) arguments   | `--audit-level=low`              |
@@ -319,7 +319,7 @@ The Node template features a job `node-outdated` that performs outdated analysis 


It is bound to the `test` stage.



| Name                      | description                                                                                                                                                           | default value                      |

| Name                      | Description                                                                                                                                                           | Default value                      |

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

| `NODE_OUTDATED_DISABLED`  | Set to `true` to disable npm outdated                                                                                                                                 | _none_ (enabled)                   |

| `NODE_OUTDATED_ARGS`      | npm [outdated](https://docs.npmjs.com/cli/v8/commands/npm-outdated) arguments <br/> yarn [outdated](https://classic.yarnpkg.com/lang/en/docs/cli/outdated/) arguments | `--long`                           |
@@ -332,7 +332,7 @@ This job generates a [SBOM](https://cyclonedx.org/) file listing installed packa 


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



| Name                  | description                            | default value     |

| Name                  | Description                            | Default value     |

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

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

| `NODE_SBOM_VERSION` | The version of @cyclonedx/cyclonedx-npm used to emit SBOM | _none_ (uses latest) |
@@ -347,7 +347,7 @@ When enabled, it is executed on a Git tag with a semantic versioning pattern (`v 


It uses the following variables:



| Name                       | description                                                                 | default value     |

| Name                       | Description                                                                 | Default value     |

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

| `NODE_PUBLISH_ENABLED`     | Set to `true` to enable the publish job                                     | _none_ (disabled) |

| `NODE_PUBLISH_ARGS`        | npm [publish](https://docs.npmjs.com/cli/v8/commands/npm-publish) extra arguments<br/>yarn [publish](https://classic.yarnpkg.com/lang/en/docs/cli/publish/) extra arguments | _none_ |