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

docs: fix configuration doc syntax

Browse Source
This commit is contained in:
Pierre Vanduynslager 2018-07-29 23:29:32 -04:00
parent d8c84a0e0b
commit 31ec1eb5de
1 changed files with 29 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
docs/usage/configuration.md
View File

@ -57,8 +57,7 @@ $ semantic-release
### extends ### extends
Type: `Array`, `String` Type: `Array`, `String`<br>
CLI arguments: `-e`, `--extends` CLI arguments: `-e`, `--extends`
List of modules or file paths containing a [shareable configuration](shareable-configurations.md). If multiple shareable configurations are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration. List of modules or file paths containing a [shareable configuration](shareable-configurations.md). If multiple shareable configurations are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration.
@ -67,20 +66,16 @@ List of modules or file paths containing a [shareable configuration](shareable-c
### branch ### branch
Type: `String` Type: `String`<br>
Default: `master`<br>
Default: `master`
CLI arguments: `-b`, `--branch` CLI arguments: `-b`, `--branch`
The branch on which releases should happen. The branch on which releases should happen.
### repositoryUrl ### repositoryUrl
Type: `String` Type: `String`<br>
Default: `repository` property in `package.json` or [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes)<br>
Default: `repository` property in `package.json` or [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes)
CLI arguments: `-r`, `--repository-url` CLI arguments: `-r`, `--repository-url`
The git repository URL. The git repository URL.
@ -89,10 +84,8 @@ Any valid git url format is supported (See [Git protocols](https://git-scm.com/b
### tagFormat ### tagFormat
Type: `String` Type: `String`<br>
Default: `v${version}`<br>
Default: `v${version}`
CLI arguments: `-t`, `--tag-format` CLI arguments: `-t`, `--tag-format`
The [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) format used by **semantic-release** to identify releases. The tag name is generated with [Lodash template](https://lodash.com/docs#template) and will be compiled with the `version` variable. The [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) format used by **semantic-release** to identify releases. The tag name is generated with [Lodash template](https://lodash.com/docs#template) and will be compiled with the `version` variable.
@ -101,40 +94,32 @@ The [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) format used by
### dryRun ### dryRun
Type: `Boolean` Type: `Boolean`<br>
Default: `false` if running in a CI environment, `true` otherwise<br>
Default: `false` if running in a CI environment, `true` otherwise
CLI arguments: `-d`, `--dry-run` CLI arguments: `-d`, `--dry-run`
Dry-run mode, skip publishing, print next version and release notes. Dry-run mode, skip publishing, print next version and release notes.
### noCi ### noCi
Type: `Boolean` Type: `Boolean`<br>
Default: `false`<br>
Default: `false`
CLI arguments: `--no-ci` CLI arguments: `--no-ci`
Skip Continuous Integration environment verifications. This allows for making releases from a local machine. Skip Continuous Integration environment verifications. This allows for making releases from a local machine.
### debug ### debug
Type: `Boolean` Type: `Boolean`<br>
Default: `false`<br>
Default: `false`
CLI argument: `--debug` CLI argument: `--debug`
Output debugging information. It can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`. Output debugging information. It can also be enabled by setting the `DEBUG` environment variable to `semantic-release:*`.
### verifyConditions ### verifyConditions
Type: `Array`, `String`, `Object` Type: `Array`, `String`, `Object`<br>
Default: `['@semantic-release/npm', '@semantic-release/github']`<br>
Default: `['@semantic-release/npm', '@semantic-release/github']`
CLI argument: `--verify-conditions` CLI argument: `--verify-conditions`
Define the list of [verify conditions plugins](plugins.md#verifyconditions-plugin). Plugins will run in series, in the order defined in the `Array`. Define the list of [verify conditions plugins](plugins.md#verifyconditions-plugin). Plugins will run in series, in the order defined in the `Array`.
@ -143,10 +128,8 @@ See [Plugins configuration](plugins.md#configuration) for more details.
### analyzeCommits ### analyzeCommits
Type: `Array`, `String`, `Object`<br>
Default: `'@semantic-release/commit-analyzer'` Default: `'@semantic-release/commit-analyzer'`<br>
Type: `Array`, `String`, `Object`
CLI argument: `--analyze-commits` CLI argument: `--analyze-commits`
Define the [analyze commits plugin](plugins.md#analyzecommits-plugin). Define the [analyze commits plugin](plugins.md#analyzecommits-plugin).
@ -155,10 +138,8 @@ See [Plugins configuration](plugins.md#configuration) for more details.
### verifyRelease ### verifyRelease
Type: `Array`, `String`, `Object` Type: `Array`, `String`, `Object`<br>
Default: `[]`<br>
Default: `[]`
CLI argument: `--verify-release` CLI argument: `--verify-release`
Define the list of [verify release plugins](plugins.md#verifyrelease-plugin). Plugins will run in series, in the order defined in the `Array`. Define the list of [verify release plugins](plugins.md#verifyrelease-plugin). Plugins will run in series, in the order defined in the `Array`.
@ -167,10 +148,8 @@ See [Plugins configuration](plugins.md#configuration) for more details.
### generateNotes ### generateNotes
Type: `Array`, `String`, `Object` Type: `Array`, `String`, `Object`<br>
Default: `['@semantic-release/release-notes-generator']`<br>
Default: `['@semantic-release/release-notes-generator']`
CLI argument: `--generate-notes` CLI argument: `--generate-notes`
Define the [generate notes plugins](plugins.md#generatenotes-plugin). Define the [generate notes plugins](plugins.md#generatenotes-plugin).
@ -179,10 +158,8 @@ See [Plugins configuration](plugins.md#configuration) for more details.
### prepare ### prepare
Type: `Array`, `String`, `Object` Type: `Array`, `String`, `Object`<br>
Default: `['@semantic-release/npm']`<br>
Default: `['@semantic-release/npm']`
CLI argument: `--prepare` CLI argument: `--prepare`
Define the list of [prepare plugins](plugins.md#prepare-plugin). Plugins will run in series, in the order defined in the `Array`. Define the list of [prepare plugins](plugins.md#prepare-plugin). Plugins will run in series, in the order defined in the `Array`.
@ -191,10 +168,8 @@ See [Plugins configuration](plugins.md#configuration) for more details.
### publish ### publish
Type: `Array`, `String`, `Object` Type: `Array`, `String`, `Object`<br>
Default: `['@semantic-release/npm', '@semantic-release/github']`<br>
Default: `['@semantic-release/npm', '@semantic-release/github']`
CLI argument: `--publish` CLI argument: `--publish`
Define the list of [publish plugins](plugins.md#publish-plugin). Plugins will run in series, in the order defined in the `Array`. Define the list of [publish plugins](plugins.md#publish-plugin). Plugins will run in series, in the order defined in the `Array`.
@ -203,10 +178,8 @@ See [Plugins configuration](plugins.md#configuration) for more details.
### success ### success
Type: `Array`, `String`, `Object` Type: `Array`, `String`, `Object`<br>
Default: `['@semantic-release/github']`<br>
Default: `['@semantic-release/github']`
CLI argument: `--success` CLI argument: `--success`
Define the list of [success plugins](plugins.md#success-plugin). Plugins will run in series, in the order defined in the `Array`. Define the list of [success plugins](plugins.md#success-plugin). Plugins will run in series, in the order defined in the `Array`.
@ -215,10 +188,8 @@ See [Plugins configuration](plugins.md#configuration) for more details.
### fail ### fail
Type: `Array`, `String`, `Object` Type: `Array`, `String`, `Object`<br>
Default: `['@semantic-release/github']`<br>
Default: `['@semantic-release/github']`
CLI argument: `--fail` CLI argument: `--fail`
Define the list of [fail plugins](plugins.md#fail-plugin). Plugins will run in series, in the order defined in the `Array`. Define the list of [fail plugins](plugins.md#fail-plugin). Plugins will run in series, in the order defined in the `Array`.