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

docs: update plugins package name

Browse Source
This commit is contained in:
Kévin Berthommier 2018-04-12 00:38:12 +02:00 committed by Pierre Vanduynslager
parent 6172eb807c
commit a1138a6a80
No known key found for this signature in database
GPG Key ID: 8C72FC889EB51BA5
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -20,7 +20,7 @@ See [CI configuration recipes](../recipes/README.md#ci-configurations) for more
Alternatively the Git authentication can be set up via [SSH keys](../recipes/git-auth-ssh-keys.md). Alternatively the Git authentication can be set up via [SSH keys](../recipes/git-auth-ssh-keys.md).
Most **semantic-release** [plugins](plugins.md) require setting up authentication in order to publish to a package manager registry. The default [npm](https://github.com/semantic-release/npm#environment-variables) and [github](https://github.com/semantic-release/github#environment-variables) plugins require the following environment variables: Most **semantic-release** [plugins](plugins.md) require setting up authentication in order to publish to a package manager registry. The default [@semantic-release/npm](https://github.com/semantic-release/npm#environment-variables) and [@semantic-release/github](https://github.com/semantic-release/github#environment-variables) plugins require the following environment variables:
| Variable | Description | | Variable | Description |
|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

10
docs/usage/plugins.md
View File

@ -8,7 +8,7 @@ Each [release step](../../README.md#release-steps) is implemented within a plugi
Responsible for verifying conditions necessary to proceed with the release: configuration is correct, authentication token are valid, etc... Responsible for verifying conditions necessary to proceed with the release: configuration is correct, authentication token are valid, etc...
Default implementation: [npm](https://github.com/semantic-release/npm#verifyconditions) and [github](https://github.com/semantic-release/github#verifyconditions). Default implementation: [@semantic-release/npm](https://github.com/semantic-release/npm#verifyconditions) and [@semantic-release/github](https://github.com/semantic-release/github#verifyconditions).
### analyzeCommits plugin ### analyzeCommits plugin
@ -34,25 +34,25 @@ Responsible for preparing the release, including:
- Creating or updating files such as `package.json`, `CHANGELOG.md`, documentation or compiled assets. - Creating or updating files such as `package.json`, `CHANGELOG.md`, documentation or compiled assets.
- Create and push commits - Create and push commits
Default implementation: [npm](https://github.com/semantic-release/npm#prepare). Default implementation: [@semantic-release/npm](https://github.com/semantic-release/npm#prepare).
### publish plugin ### publish plugin
Responsible for publishing the release. Responsible for publishing the release.
Default implementation: [npm](https://github.com/semantic-release/npm#publish) and [github](https://github.com/semantic-release/github#publish). Default implementation: [@semantic-release/npm](https://github.com/semantic-release/npm#publish) and [@semantic-release/github](https://github.com/semantic-release/github#publish).
### success plugin ### success plugin
Responsible for notifying of a new release. Responsible for notifying of a new release.
Default implementation: [github](https://github.com/semantic-release/github#success). Default implementation: [@semantic-release/github](https://github.com/semantic-release/github#success).
### fail plugin ### fail plugin
Responsible for notifying of a failed release. Responsible for notifying of a failed release.
Default implementation: [github](https://github.com/semantic-release/github#fail). Default implementation: [@semantic-release/github](https://github.com/semantic-release/github#fail).
## Configuration ## Configuration