-
Notifications
You must be signed in to change notification settings - Fork 3.8k
chore(docs): update unpublish docs with both commands, removing policy info from cli docs, and added reference to unpublish policy docs #730
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 <package-name>@<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 <package-name> -f | ||
nomadtechie marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| 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 | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.