diff --git a/README.md b/README.md index 67c6926266de9b1ded4015ba379d3f9b0e217e69..5ebc01e412288257fe522f6faa6fbbbce0b7fd39 100644 --- a/README.md +++ b/README.md @@ -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_ |