From 0295e2fef18dae563aa94014e24f52520cacda26 Mon Sep 17 00:00:00 2001 From: David Goss Date: Wed, 31 Aug 2022 08:29:47 +0100 Subject: [PATCH] docs: document that .cjs extensions are supported for config files --- docs/usage/configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/usage/configuration.md b/docs/usage/configuration.md index 0b4aac54c0..ab043566e0 100644 --- a/docs/usage/configuration.md +++ b/docs/usage/configuration.md @@ -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. @@ -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