-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
95cb19f
commit ab46b05
Showing
3 changed files
with
427 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,36 @@ | ||
# npm | ||
# @semrel-extra/npm | ||
Drop-in-repl npm plugin to handle `npm-whoami` throttling issue for monorepos: https://github.com/semantic-release/npm/issues/414 | ||
|
||
### Install | ||
```shell | ||
npm i -D @semrel-extra/npm | ||
``` | ||
|
||
### Usage | ||
`@semrel-extra/npm` is just a wrapper, so it inherits the API contract of [@semantic-release/npm](https://github.com/semantic-release/npm). | ||
Follow [its docs](https://github.com/semantic-release/npm/blob/master/README.md): | ||
|
||
| Step | Description | | ||
|--------------------|-------------| | ||
| `verifyConditions` | Verify the presence of the `NPM_TOKEN` environment variable, or an `.npmrc` file, and verify the authentication method is valid. | | ||
| `prepare` | Update the `package.json` version and [create](https://docs.npmjs.com/cli/pack) the npm package tarball. | | ||
| `addChannel` | [Add a release to a dist-tag](https://docs.npmjs.com/cli/dist-tag). | | ||
| `publish` | [Publish the npm package](https://docs.npmjs.com/cli/publish) to the registry. | | ||
|
||
```json | ||
{ | ||
"plugins": [ | ||
"@semantic-release/commit-analyzer", | ||
["@semrel-extra/npm", { | ||
... | ||
}], | ||
["@semantic-release/git", { | ||
"assets": ["package.json", "npm-shrinkwrap.json"] | ||
}] | ||
] | ||
} | ||
|
||
``` | ||
|
||
### License | ||
[MIT](./LICENSE) |
Oops, something went wrong.