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

revert: docs: corrections and further clarifications

Browse Source 
This reverts commit 7cb5446bb5.
This commit is contained in:
Pierre Vanduynslager
2019-08-22 14:47:21 -04:00
parent 58aaf057f6
commit ce3d1bc715
8 changed files with 39 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/01-usage/configuration.md
+1 -1
View File
@@ -154,7 +154,7 @@ Example (`.releaserc` file content):
"@semantic-release/release-notes-generator",
"@semantic-release-docker",
["@semantic-release/exec", {
"verifyConditionsCmd": "./verify.sh"
"verifyConditionsCmd": "./verify.sh" # plugin configuration
}],
"@semantic-release/git",
"@semantic-release/gitlab",
docs/01-usage/installation.md
+8 -1
View File
@@ -18,5 +18,12 @@ $ npx semantic-release
## Global installation
> **Note:** Global installation is no longer recommended. Please use local installation and `npx` instead.
For other type of projects we recommend installing **semantic-release** directly in the CI environment, also with [npx](https://www.npmjs.com/package/npx):
```bash
$ npx semantic-release
```
> **Note:** For a global installation, it's recommended to specify the major **semantic-release** version to install (for example with with `npx semantic-release@15`, or `npm install -g semantic-release@15`). This way your build will not automatically use the next major **semantic-release** release that could possibly break your build. You will have to upgrade manually when a new major version is released.
> **Note:** `npx` is a tool bundled with `npm@>=5.2.0`. It is used to conveniently install the semantic-release binary and to execute it. See [What is npx](../05-support/FAQ.md#what-is-npx) for more details.
docs/01-usage/plugins.md
+2 -2
View File
@@ -75,11 +75,11 @@ Global plugin options can defined at the root of the **semantic-release** config
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
["@semantic-release/github", {
"assets": ["dist/**"]
"assets": ["dist/**"] # plugin configuration
}],
"@semantic-release/git"
],
"preset": "angular"
"preset": "angular" # option passed to all plugins
}
```
docs/01-usage/shareable-configurations.md
+3 -3
View File
@@ -1,7 +1,7 @@
# Shareable configurations
A shareable configuration is an npm package that exports a **semantic-release** configuration object. It allows for use of the same configuration across several projects.
A shareable configuration is an [npm](https://www.npmjs.com/) package that exports a **semantic-release** configuration object. It allows for use of the same configuration across several projects.
Shareable configurations to be use can be declared with the [`extends` option](configuration.md#extends).
The shareable configurations to use can be set with the [extends](configuration.md#extends) option.
See [shareable configurations list](../02-extending/shareable-configurations-list.md) for examples.
See [shareable configurations list](../02-extending/shareable-configurations-list.md).