Skip to content

Commit

Permalink
docs: clarify config file format
Browse files Browse the repository at this point in the history
  • Loading branch information
pvdlg committed Jun 4, 2018
1 parent ddcf29a commit 4d47b20
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/usage/configuration.md
Expand Up @@ -6,7 +6,7 @@ In order to customize **semantic-release**’s behavior, [options](#options) and
- A `release` key in the project's `package.json` file
- CLI arguments

The following two examples are the same.
The following three examples are the same.

Via CLI argument:

Expand All @@ -17,7 +17,20 @@ $ semantic-release --branch next
Via `release` key in the project's `package.json` file:

```json
"release": {
{
"release": {
"branch": "next"
}
}
```
```bash
$ semantic-release
```

Via `.releaserc` file:

```json
{
"branch": "next"
}
```
Expand All @@ -29,6 +42,8 @@ $ semantic-release

**Note**: Plugin options cannot be defined via CLI arguments and must be defined in the configuration file.

**Note**: When configuring via `package.json`, the configuration must be under the `release` property. However, when using a `.releaserc` or a `release.config.js` file, the configuration must be set without a `release` property.

## Environment variables

| Variable | Description | Default |
Expand Down

0 comments on commit 4d47b20

Please sign in to comment.