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

docs: corrections and further clarifications

Browse Source 
- (correction) removed comments from code samples.
-(correction) remove recommendation for global
install on CI environemnts.
- Synched README.md and SUMMARY.md
This commit is contained in:
Emmanuel Sciara 2019-07-31 23:04:20 +02:00 committed by Gregor Martynus
parent 5a5eaec3da
commit 7cb5446bb5
8 changed files with 22 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -93,22 +93,22 @@ After running the tests, the command `semantic-release` will execute the followi
## Documentation ## Documentation
- Usage - Usage
- [Getting started](docs/01-usage/01-getting-started.md) - [Getting started](docs/01-usage/getting-started.md)
- [Installation](docs/01-usage/installation.md#installation) - [Installation](docs/01-usage/installation.md#installation)
- [CI Configuration](docs/01-usage/ci-configuration.md#ci-configuration) - [CI Configuration](docs/01-usage/ci-configuration.md#ci-configuration)
- [Configuration](docs/01-usage/configuration.md#configuration) - [Configuration](docs/01-usage/configuration.md#configuration)
- [Plugins](docs/01-usage/plugins.md) - [Plugins](docs/01-usage/plugins.md)
- [Shareable configurations](docs/01-usage/shareable-configurations.md) - [Shareable configurations](docs/01-usage/shareable-configurations.md)
- Extending - Extending
- [Plugins](docs/02-extending/plugins-list.md) - [Available plugins](docs/02-extending/plugins-list.md)
- [Shareable configuration](docs/02-extending/shareable-configurations-list.md) - [Available shareable configuration](docs/02-extending/shareable-configurations-list.md)
- Recipes - Recipes
- [CI pipelines recipes](docs/03-recipes/ci-pipelines-recipes.md) - [CI pipelines recipes](docs/03-recipes/ci-pipelines-recipes.md)
- [CircleCI 2.0 workflows](docs/03-recipes/circleci-workflows.md) - [CircleCI 2.0 workflows](docs/03-recipes/circleci-workflows.md)
- [Travis CI](docs/03-recipes/travis.md) - [Travis CI](docs/03-recipes/travis.md)
- [GitLab CI](docs/03-recipes/gitlab-ci.md) - [GitLab CI](docs/03-recipes/gitlab-ci.md)
- [Git hosted services](docs/03-recipes/git-hosted-services.md) - [Git hosted services](docs/03-recipes/git-hosted-services.md)
- [Git authentication with SSH keys](docs/03-recipes/git-auth-ssh-keys.md) - [Git authentication with SSH keys](docs/03-recipes/git-auth-ssh-keys.md)
- [Package managers and languages](docs/03-recipes/package-managers-and-languages.md) - [Package managers and languages](docs/03-recipes/package-managers-and-languages.md)
- Developer guide - Developer guide
- [JavaScript API](docs/04-developer-guide/js-api.md) - [JavaScript API](docs/04-developer-guide/js-api.md)

12
SUMMARY.md
View File

@ -9,16 +9,16 @@
- [Shareable configurations](docs/01-usage/shareable-configurations.md) - [Shareable configurations](docs/01-usage/shareable-configurations.md)
## Extensions ## Extensions
- [Plugins](docs/02-extending/plugins-list.md) - [Available plugins](docs/02-extending/plugins-list.md)
- [Shareable configuration](docs/02-extending/shareable-configurations-list.md) - [Available shareable configuration](docs/02-extending/shareable-configurations-list.md)
## Recipes ## Recipes
- [CI pipelines recipes](docs/03-recipes/ci-pipelines-recipes.md) - [CI pipelines recipes](docs/03-recipes/ci-pipelines-recipes.md)
- [CircleCI 2.0 workflows](docs/03-recipes/circleci-workflows.md) - [CircleCI 2.0 workflows](docs/03-recipes/circleci-workflows.md)
- [Travis CI](docs/03-recipes/travis.md) - [Travis CI](docs/03-recipes/travis.md)
- [GitLab CI](docs/03-recipes/gitlab-ci.md) - [GitLab CI](docs/03-recipes/gitlab-ci.md)
- [Git hosted services](docs/03-recipes/git-hosted-services.md) - [Git hosted services](docs/03-recipes/git-hosted-services.md)
- [Git authentication with SSH keys](docs/03-recipes/git-auth-ssh-keys.md) - [Git authentication with SSH keys](docs/03-recipes/git-auth-ssh-keys.md)
- [Package managers and languages](docs/03-recipes/package-managers-and-languages.md) - [Package managers and languages](docs/03-recipes/package-managers-and-languages.md)
## Developer guide ## Developer guide

2
docs/01-usage/configuration.md
View File

@ -154,7 +154,7 @@ Example (`.releaserc` file content):
"@semantic-release/release-notes-generator", "@semantic-release/release-notes-generator",
"@semantic-release-docker", "@semantic-release-docker",
["@semantic-release/exec", { ["@semantic-release/exec", {
"verifyConditionsCmd": "./verify.sh" # plugin configuration "verifyConditionsCmd": "./verify.sh"
}], }],
"@semantic-release/git", "@semantic-release/git",
"@semantic-release/gitlab", "@semantic-release/gitlab",

9
docs/01-usage/installation.md
View File

@ -18,12 +18,5 @@ $ npx semantic-release
## Global installation ## Global installation
For other type of projects we recommend installing **semantic-release** directly in the CI environment, also with [npx](https://www.npmjs.com/package/npx): > **Note:** For a global installation is no longer recommended. Please use local installation and `npx` instead.
```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.

4
docs/01-usage/plugins.md
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/commit-analyzer",
"@semantic-release/release-notes-generator", "@semantic-release/release-notes-generator",
["@semantic-release/github", { ["@semantic-release/github", {
"assets": ["dist/**"] # plugin configuration "assets": ["dist/**"]
}], }],
"@semantic-release/git" "@semantic-release/git"
], ],
"preset": "angular" # option passed to all plugins "preset": "angular"
} }
``` ```

6
docs/01-usage/shareable-configurations.md
View File

@ -1,7 +1,7 @@
# Shareable configurations # Shareable configurations
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. 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.
The shareable configurations to use can be set with the [extends](configuration.md#extends) option. Shareable configurations to be use can be declared with the [`extends` option](configuration.md#extends).
See [shareable configurations list](../02-extending/shareable-configurations-list.md). See [shareable configurations list](../02-extending/shareable-configurations-list.md) for examples.

2
docs/03-recipes/ci-configurations-recipes.md → docs/03-recipes/ci-pipelines-recipes.md
View File

@ -1,4 +1,4 @@
# CI configurations # CI pipelines recipes
- [CircleCI 2.0 workflows](circleci-workflows.md) - [CircleCI 2.0 workflows](circleci-workflows.md)
- [Travis CI](travis.md) - [Travis CI](travis.md)
- [GitLab CI](gitlab-ci.md) - [GitLab CI](gitlab-ci.md)

12
docs/03-recipes/git-hosted-services.md
View File

@ -1,12 +1,2 @@
# Recipes # Git hosted services
## CI configurations
- [CircleCI 2.0 workflows](circleci-workflows.md)
- [Travis CI](travis.md)
- [GitLab CI](gitlab-ci.md)
## Git hosted services
- [Git authentication with SSH keys](git-auth-ssh-keys.md) - [Git authentication with SSH keys](git-auth-ssh-keys.md)
## Package managers and languages (to be completed)