simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: grammar corrections

Browse Source
This commit is contained in:
Andy Edwards 2018-11-27 15:04:50 -06:00 committed by Pierre Vanduynslager
parent eafbb343dd
commit d6d1bc954e
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/usage/configuration.md
View File

@ -1,11 +1,11 @@
# Configuration
**semantic-release** configuration consist of:
**semantic-release** configuration consists of:
- Git repository options ([URL](#repositoryurl), [release branch](#branch) and [tag format](#tagformat))
- [plugins](#plugins) definition
- run mode ([debug](#debug), [dry run](#dryrun) and [local (no CI)](#ci))
All those options can be configured directly or by extending a [shareable configuration](shareable-configurations.md).
All of these options can be configured directly or by extending a [shareable configuration](shareable-configurations.md).
Additionally, metadata of Git tags generated by **semantic-release** can be customized via standard [Git environment variables](#git-environment-variables).
@ -16,7 +16,7 @@ Additionally, metadata of Git tags generated by **semantic-release** can be cust
- A `release.config.js` file that exports an object
- A `release` key in the project's `package.json` file
Alternatively some options can be set via CLI arguments.
Alternatively, some options can be set via CLI arguments.
The following three examples are the same.
@ -131,7 +131,7 @@ Type: `Boolean`<br>
Default: `false`<br>
CLI argument: `--debug`
Output debugging information. It can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`.
Output debugging information. This can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`.
## Git environment variables
@ -144,7 +144,7 @@ Output debugging information. It can also be enabled by setting the `DEBUG` envi
## Existing version tags
**semantic-release** uses [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) to determine the commits added since the last release. If a release have been published before setting up **semantic-release** you must make sure the most recent commit included in the last published release is in the [release branch](#branch) history and is tagged with the version released, formatted according to the [tag format](#tagformat) configured (defaults to `vx.y.z`).
**semantic-release** uses [Git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) to determine the commits added since the last release. If a release has been published before setting up **semantic-release** you must make sure the most recent commit included in the last published release is in the [release branch](#branch) history and is tagged with the version released, formatted according to the [tag format](#tagformat) configured (defaults to `vx.y.z`).
If the previous releases were published with [`npm publish`](https://docs.npmjs.com/cli/publish) this should already be the case.