Commit 449be17e authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent 5c64ac0a

README.md

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


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



| Name                  | description                            | default value     |

| Name                  | Description                            | Default value     |

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

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

| `PHP_PROJECT_DIR`     | The PHP project root directory         | `.`               |
@@ -62,7 +62,7 @@ is found in the project (`phpunit.xml` or `phpunit.xml.dist`). 


It uses the following variable:



| Name                  | description                              | default value     |

| Name                  | Description                              | Default value     |

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

| `PHP_UNIT_ARGS`       | Additional PHPUnit [options](https://docs.phpunit.de/en/10.2/textui.html#command-line-options) | _none_ |

| `PHP_UNIT_DISABLED`   | Set to `true` to disable PHPUnit test (if some `phpunit.xml` or `phpunit.xml.dist` file unintentionally triggers the build) | _none_ (auto based on presence of `phpunit.xml` or `phpunit.xml.dist` file) |
@@ -86,7 +86,7 @@ It is bound to the `test` stage, and is **enabled by default**. 


It uses the following variable:



| Name                       | description                              | default value     |

| Name                       | Description                              | Default value     |

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

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

| `PHP_CODESNIFFER_ARGS`     | PHP_CodeSniffer [options](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options) | _none_ |
@@ -133,7 +133,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     |

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

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

| `PHP_SBOM_VERSION` | The version of @cyclonedx/cyclonedx-php used to emit SBOM | _none_ (uses latest) |
@@ -147,7 +147,7 @@ It is bound to the `test` stage, and can be run manually at will. 


It uses the following variable:



| Name                | description                              | default value     |

| Name                | Description                              | Default value     |

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

| `PHP_OUTDATED_OPTS` | [`composer outdated` options](https://getcomposer.org/doc/03-cli.md#outdated) | `--direct` |
@@ -157,7 +157,7 @@ This job performs a vulnerability scan in your dependencies with [`composer audi 


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



| Name                | description                              | default value     |

| Name                | Description                              | Default value     |

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

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

| `PHP_COMPOSER_AUDIT_OPTS` | [`composer audit` options](https://getcomposer.org/doc/03-cli.md#audit) | `--locked` |