-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): update unpublish docs with both commands, removing polic…
…y info from cli docs, and added reference to unpublish policy docs Co-Authored-By: Michael 'afrolion' Perrotte <[email protected]> PR-URL: #730 Credit: @nomadtechie Close: #730 Reviewed-by: @darcyclarke
- Loading branch information
1 parent
3b9c135
commit f9248c0
Showing
2 changed files
with
17 additions
and
17 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 |
---|---|---|
|
@@ -10,19 +10,21 @@ description: Remove a package from the registry | |
|
||
### Synopsis | ||
|
||
#### Unpublishing a single version of a package | ||
|
||
```bash | ||
npm unpublish [<@scope>/]<pkg>[@<version>] | ||
npm unpublish [<@scope>/]<pkg>@<version> | ||
``` | ||
|
||
### Warning | ||
#### Unpublishing an entire package | ||
|
||
**It is generally considered bad behavior to remove versions of a library | ||
that others are depending on!** | ||
```bash | ||
npm unpublish [<@scope>/]<pkg> --force | ||
``` | ||
|
||
Consider using the `deprecate` command | ||
instead, if your intent is to encourage users to upgrade. | ||
### Warning | ||
|
||
There is plenty of room on the registry. | ||
Consider using the `deprecate` command instead, if your intent is to encourage users to upgrade, or if you no longer want to maintain a package. | ||
|
||
### Description | ||
|
||
|
@@ -34,16 +36,10 @@ the root package entry is removed from the registry entirely. | |
|
||
Even if a package version is unpublished, that specific name and | ||
version combination can never be reused. In order to publish the | ||
package again, a new version number must be used. Additionally, | ||
new versions of packages with every version unpublished may not | ||
be republished until 24 hours have passed. | ||
package again, a new version number must be used. If you unpublish the entire package, you may not publish any new versions of that package until 24 hours have passed. | ||
|
||
With the default registry (`registry.npmjs.org`), unpublish is | ||
only allowed with versions published in the last 72 hours. If you | ||
are trying to unpublish a version published longer ago than that, | ||
contact [email protected]. | ||
To learn more about how unpublish is treated on the npm registry, see our <a href="https://www.npmjs.com/policies/unpublish" target="_blank" rel="noopener noreferrer"> unpublish policies</a>. | ||
|
||
The scope is optional and follows the usual rules for [`scope`](/using-npm/scope). | ||
|
||
### See Also | ||
|
||
|
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