Commit 2f768f5d authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent 1b60f41c

README.md

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


The semantic-release template uses some global configuration used throughout all jobs.



| Name                  | description                                   | default value     |

| Name                  | Description                                   | Default value     |

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

| `SEMREL_IMAGE`        | The Docker image used to run semantic-release | `registry.hub.docker.com/library/node:latest` |

| `SEMREL_VERSION`      | The [semantic-release](https://www.npmjs.com/package/semantic-release) version to use | `latest` |
@@ -63,7 +63,7 @@ If no configuration is found, the template will generate one with the following 


As specified in the previous chapter, these variables are only used to generated a `.releaserc` when no configuration is found in the repository.



| Name                          | description                                            | default value |

| Name                          | Description                                            | Default value |

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

| `SEMREL_CHANGELOG_ENABLED`    | Add the [@semantic-release/changelog](https://github.com/semantic-release/changelog) plugin which will commit a changelog file in the repository if set to `true`. | _none_ |

| `SEMREL_CHANGELOG_FILE`    | [changelogFile @semantic-release/changelog option](https://github.com/semantic-release/changelog#options). | _none_ (use the plugin default value which is `CHANGELOG.md`). |
@@ -141,7 +141,7 @@ For an introduction on commit signing, see [GitLab documentation](https://docs.g 


To make semantic-release sign its commits, use the following variable.



| Name                 | description                                                              | default value |

| Name                 | Description                                                              | Default value |

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

| :lock: `SEMREL_GPG_SIGNKEY` | Path to the GPG signkey exported with `gpg --armor --export-secret-key`<br/>:warning: Declare as a masked [project variable of File type](https://docs.gitlab.com/ee/ci/variables/#cicd-variable-types). | _none_        |