Skip to content

Commit

Permalink
Polish
Browse files Browse the repository at this point in the history
  • Loading branch information
loic-sharma committed Apr 17, 2021
1 parent f72e5f0 commit f8f4b02
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ dotnet tool install --global nuget-clear --version 1.0.0-preview1

## Examples

Let's find some versions of your package to delete:
Let's find some versions of your package to delete on nuget.org:

```
nuclear list My.Package
Expand All @@ -32,12 +32,18 @@ Let's nuke some packages! 🤯
nuclear delete My.Package 2.0.0-* --api-key NUGET_API_KEY
```

This [unlists](https://docs.microsoft.com/en-us/nuget/nuget-org/policies/deleting-packages) pre-releases of v2.0.0 of `My.Package` on nuget.org.
This [unlists](https://docs.microsoft.com/nuget/nuget-org/policies/deleting-packages) pre-releases of `My.Package` v2.0.0 on nuget.org.

You can create API keys on nuget.org using [this documentation](https://docs.microsoft.com/en-us/nuget/nuget-org/publish-a-package#create-api-keys). Make sure to select the `Unlist package` scope when creating your API key.
You can create API keys on nuget.org using [this documentation](https://docs.microsoft.com/nuget/nuget-org/publish-a-package#create-api-keys). Make sure to select the `Unlist package` scope when creating your API key.

## Reference

### Deleting vs unlisting?

NuGet servers are free to interpret "delete" operations. For example, [nuget.org unlists packages](https://docs.microsoft.com/nuget/nuget-org/policies/deleting-packages) to prevent the ["left-pad problem"](https://blog.npmjs.org/post/141577284765/kik-left-pad-and-npm). Unlisted packages are undiscoverable on nuget.org and may be re-listed in the future.

However, private NuGet servers like [BaGet can be configured to delete packages](https://loic-sharma.github.io/BaGet/configuration/#enable-package-hard-deletions). You may not be able to undo a package deletion, so be careful!

### Version ranges

NuGet packages use [semantic versioning](https://semver.org/) and has the form `Major.Minor.Patch[-PreleaseLabel]`. Examples include `1.0.0` or `1.0.0-preview1`. A package is considered *pre-release* if it has a pre-release label, or *stable* otherwise.
Expand Down

0 comments on commit f8f4b02

Please sign in to comment.