Skip to content

Commit

Permalink
docs: document that .cjs extensions are supported for config files (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
davidjgoss committed Sep 2, 2022
1 parent 762d0f5 commit e516748
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/usage/configuration.md
Expand Up @@ -12,8 +12,8 @@ Additionally, metadata of Git tags generated by **semantic-release** can be cust
## Configuration file

**semantic-release**’s [options](#options), mode and [plugins](plugins.md) can be set via either:
- A `.releaserc` file, written in YAML or JSON, with optional extensions: .`yaml`/`.yml`/`.json`/`.js`
- A `release.config.js` file that exports an object
- A `.releaserc` file, written in YAML or JSON, with optional extensions: `.yaml`/`.yml`/`.json`/`.js`/`.cjs`
- A `release.config.(js|cjs)` file that exports an object
- A `release` key in the project's `package.json` file

Alternatively, some options can be set via CLI arguments.
Expand Down Expand Up @@ -45,7 +45,7 @@ $ semantic-release --branches next

**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.
**Note**: When configuring via `package.json`, the configuration must be under the `release` property. However, when using a `.releaserc` or a `release.config` file, the configuration must be set without a `release` property.

## Options

Expand Down

0 comments on commit e516748

Please sign in to comment.