Commit da0e6bb5 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent 766732a5

README.md

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


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



| Name           | description                                   | default value                                                             |

| Name           | Description                                   | Default value                                                             |

|----------------|-----------------------------------------------|:--------------------------------------------------------------------------|

| `NG_CLI_IMAGE`        | The Docker image used to run Angular-CLI (ng) <br/>:warning: **set the version required by your project** | `registry.hub.docker.com/trion/ng-cli-karma:latest` |

| `NPM_CONFIG_REGISTRY` | NPM [registry](https://docs.npmjs.com/configuring-your-registry-settings-as-an-npm-enterprise-user)                | _none_ (defaults to `https://registry.npmjs.org`) |
@@ -54,7 +54,7 @@ The Angular template features a job `ng-lint` that performs Angular source code 


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



| Name           | description                                              | default value |

| Name           | Description                                              | Default value |

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

| `NG_LINT_ARGS` | Angular [ng lint](https://angular.io/cli/lint) arguments | `lint`        |
@@ -67,7 +67,7 @@ for jobs dependency reasons (some jobs such as SONAR analysis have a dependency 


Those stage are bound to the `build` stage, and uses the following variable:



| Name            | description                                                | default value                                     |

| Name            | Description                                                | Default value                                     |

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

| `NG_TEST_ARGS`  | Angular [ng test](https://angular.io/cli/test) arguments   | `test --code-coverage --reporters progress,junit --watch=false --no-progress` |

| `NG_BUILD_ARGS` | Angular [ng build](https://angular.io/cli/build) arguments | `build`                                           |
@@ -267,7 +267,7 @@ Additionally, if using **SonarQube**, you may also want to generate [SonarQube g 
The Angular template features a job `ng-e2e` that performs **protractor tests**

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



| Name                 | description                                                | default value                            |

| Name                 | Description                                                | Default value                            |

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

| `NG_E2E_ARGS`        | Angular [ng e2e](https://angular.io/cli/e2e) arguments     | `e2e`                                    |

| `NG_E2E_ENABLED`     | set to `true`to enable the e2e tests execution             | *none (disabled by default)*             |
@@ -298,7 +298,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     |

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

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

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


It uses the following variables:



| Name                       | description                                                                 | default value                                                    |

| Name                       | Description                                                                 | Default value                                                    |

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

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

| `NG_PUBLISH_PROJECTS`      | Space separated list of projects to publish                                 | _none_ (all workspace projects are published) |