Add prerelease option to dotnet.exe add package command #9699

martinrrm · 2020-06-18T22:21:04Z

Design for new prerelease option in dotnet.exe add

ghost · 2020-06-18T22:21:18Z

All CLA requirements met.

designs/Prerelease-Option.md

nkolev92 · 2020-06-18T22:38:34Z

designs/Prerelease-Option.md

+| `dotnet.exe add package --prerelease` | 3.3.1-preview.3 | latest version of package |
+| `dotnet.exe add package --prerelease --version 3.0.0` | error | The user cannot use this commands at the same time |
+
+```package 2.0.0


nit:
when you format put it on a new line.

A couple of questions/observations:

Using the —prerelease option should get the latest version including prerelease. Correct?

I find the name of the option a bit long. Can we also enable —pre may in addition to —prerelease? - a nit

Yes. Similar to how the PM UI behaves. If you have the prerelease filter we show you the latest version if it's prerelease.

We just opted for the full name cause I haven't seen option names not being the exact word. We can't really do --pre as short hand. A short option must be one letter only.
So we either have --prerelease or --pre.

Personally, I'd rather go with the options that is the most instinctual. So if I forgot what the options were but I wanted to enable prereleases, my instinct would be to add --prerelease not --pre even tho it's shorter. I think intuitiveness > saving a couple key strokes.

designs/Prerelease-Option.md

Pull request comments

Add future work

zivkan · 2020-06-19T23:23:28Z

Please improve the PR title, as when looking at the pull request list, I have no idea what this is adding prerelease option to.

designs/Prerelease-Option.md

nkolev92 · 2020-06-20T01:52:06Z

@chgill-MSFT @JonDouglas Can we get some PM eyes on this?

@KathleenDollard @dsplaisted @wli3 @marcpopMSFT some CLI eyes on this?

wli3 · 2020-06-20T04:43:06Z

designs/Prerelease-Option.md

+Packages available
+
+```
+package 2.0.0


Is 0.9 considered prerelease?
given versions:
0.8
0.9

with --prerelease -> 0.9
without -> fail ?

I don’t think so and @nkolev92 can confirm. The definition of prerelease is a version with “-“ in it.

Nope, as @anangaur mentioned, prerelease requires a - in the version.
0.9 is just a weird stable :D

For reference: https://nugettoolsdev.azurewebsites.net/5.5.0-preview.2.6382/parse-version?version=0.9

Is there any formatting that includes the - for a non-preview version or doesn't have the - for a preview version? Is that formatting enforced in other places as well and documented?

Is there any formatting that includes the - for a non-preview version or doesn't have the - for a preview version?

Nope, that's per the semver specification.
Documented here: https://docs.microsoft.com/en-us/nuget/concepts/package-versioning

Looks like I can restore a package without 1.0 with *. So that should be fine

<PackageReference Include="xunit.analyzers" Version="*" />

wli3 · 2020-06-22T23:29:18Z

Is there anyway to get prerelease using csproj? Or dotnet tool still cannot get prerelease packages. (one of the top asks) Note, dotnet tool still uses a temp project which has something like

<PackageReference Include="my-tool" Version="*" />

chrisraygill · 2020-06-23T00:01:30Z

Is there anyway to get prerelease using csproj? Or dotnet tool still cannot get prerelease packages. (one of the top asks) Note, dotnet tool still uses a temp project which has something like
<PackageReference Include="my-tool" Version="*" />

In the csproj you can specify latest version including prerelease with *-*. Something like 5.*-* also works to get the latest version including prelease in the version 5 range.

Does that answer your question @wli3?

nkolev92 · 2020-06-23T00:18:19Z

What @chgill-MSFT said.

See #912 was fixed in 5.6.

wli3 · 2020-06-23T00:21:48Z

ah, that was in already. Great!

nkolev92 · 2020-06-25T23:23:49Z

@chgill-MSFT @JonDouglas

You guys good with this design?
Think the only topic of potential contention is the option name. @anangaur suggested it might be too long, but personally I think it's ok to be explicit.

chrisraygill · 2020-06-25T23:29:46Z

designs/Prerelease-Option.md

+
+## Goals
+
+Add an option to the command `add package` to enable installing latest prerelease version.


Just nitpick, but I think the goal should be framed as helping a customer accomplish a "job to be done." In this case the goal should be something like:

"Allow dotnet CLI users to easily install the latest version of NuGet package, including prereleases. This can be accomplished by adding an option to the existing add package that enables installing prerelease versions."

designs/Prerelease-Option.md

chrisraygill · 2020-06-25T23:43:39Z

designs/Prerelease-Option.md

+package 2.0.0
+package 3.0.0
+package 3.3.1-preview.3
+package 3.4.0


These examples are kind of confusing because the full command is dotnet add package <packageId>. So using a an example package named "package" makes it hard to grok. Maybe using Newtonsoft.Json would work better?

Or maybe something like Consoto.Library to reduce confusion of versions of Newtonsoft.Json that don't actually exist on nuget.org.

chrisraygill · 2020-06-25T23:48:58Z

@chgill-MSFT @JonDouglas

You guys good with this design?
Think the only topic of potential contention is the option name. @anangaur suggested it might be too long, but personally I think it's ok to be explicit.

Personally, I'm fine with --prerelease especially since it's the wording we use elsewhere in NuGet so it'll be easy to remember. Added a relevant comment to the comment thread with Anand.

nkolev92 · 2020-06-25T23:53:38Z

@chgill-MSFT No precedent afaik.
nuget.exe install uses the complete spelling, https://docs.microsoft.com/en-us/nuget/reference/cli-reference/cli-ref-install.

Update

Updated scenarios table

chrisraygill · 2020-06-30T22:52:50Z

designs/Prerelease-Option.md

+|---------|--------------------|------------------|-------------|
+| `dotnet.exe add Contoso.Library` | Contoso.Library 2.0.0 <br> Contoso.Library 3.0.0 <br> Contoso.Library 3.3.1-preview.3 <br> | 3.0.0 | latest stable version of package |
+| `dotnet.exe add Contoso.Library --prerelease` | Contoso.Library 2.0.0 <br> Contoso.Library 3.0.0 <br> Contoso.Library 3.3.1-preview.3 <br> | 3.3.1-preview.3 | latest version of package |
+| `dotnet.exe add Contoso.Library --prerelease --version 3.0.0` | Contoso.Library 2.0.0 <br> Contoso.Library 3.0.0 <br> Contoso.Library 3.3.1-preview.3 <br> | error | The user cannot use the `--prerelease` and `--version` commands at the same time |


Should we error for dotnet.exe add Contoso.Library --prerelease --version 3.0.0 or just ignore the --prerelease and let it work since the intent to install version 3.0.0 seems clear? I think that exact scenario is less likely, but I could potentially see someone doing dotnet.exe add Contoso.Library --prerelease --version 3.0.0-preview thinking they need --prerelease to install it.

Erroring makes sense if that's the standard behavior of dotnet.exe in these kinds of scenarios.

I think it's ok to error when the options provided are confusing and do not make sense.

The https://docs.microsoft.com/en-us/nuget/reference/cli-reference/cli-ref-trusted-signers command throws a bunch of, hey you can't combine these switches errors.

nkolev92 · 2020-07-01T22:37:55Z

Last calls for feedback :) @chgill-MSFT @JonDouglas @anangaur

Create Prerelease-Command.md

f80971f

Design for new prerelease option in dotnet.exe add

martinrrm requested a review from nkolev92 June 18, 2020 22:21

nkolev92 reviewed Jun 18, 2020

View reviewed changes

martinrrm added 2 commits June 19, 2020 10:18

Update Prerelease-Option.md

f7701db

Pull request comments

Update Prerelease-Option.md

584074f

Add future work

martinrrm changed the title ~~Add prerelease option~~ Add prerelease option to dotnet.exe add package command Jun 19, 2020

nkolev92 self-requested a review June 19, 2020 23:49

nkolev92 approved these changes Jun 20, 2020

View reviewed changes

designs/Prerelease-Option.md Show resolved Hide resolved

nkolev92 requested review from dominoFire, donnie-msft, zivkan, chrisraygill, JonDouglas, rrelyea, anangaur, heng-liu, kartheekp-ms and zkat June 20, 2020 01:48

wli3 reviewed Jun 20, 2020

View reviewed changes

chrisraygill reviewed Jun 25, 2020

View reviewed changes

martinrrm added 2 commits June 30, 2020 11:06

Update Prerelease-Option.md

725af86

Update

Update Prerelease-Option.md

65e412f

Updated scenarios table

chrisraygill reviewed Jun 30, 2020

View reviewed changes

martinrrm requested review from nkolev92 and chrisraygill July 1, 2020 19:23

nkolev92 approved these changes Jul 1, 2020

View reviewed changes

martinrrm merged commit b6a1811 into dev Jul 6, 2020

nkolev92 deleted the dev-martinrrm-prereleaseOption branch September 1, 2020 19:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add prerelease option to dotnet.exe add package command #9699

Add prerelease option to dotnet.exe add package command #9699

martinrrm commented Jun 18, 2020

ghost commented Jun 18, 2020 •

edited by ghost

Loading

nkolev92 Jun 18, 2020

anangaur Jun 20, 2020

nkolev92 Jun 22, 2020

chrisraygill Jun 25, 2020 •

edited

Loading

zivkan commented Jun 19, 2020

nkolev92 commented Jun 20, 2020 •

edited

Loading

wli3 Jun 20, 2020

anangaur Jun 20, 2020

nkolev92 Jun 22, 2020

marcpopMSFT Jun 22, 2020

nkolev92 Jun 22, 2020 •

edited

Loading

wli3 Jun 22, 2020

wli3 commented Jun 22, 2020

chrisraygill commented Jun 23, 2020

nkolev92 commented Jun 23, 2020

wli3 commented Jun 23, 2020

nkolev92 commented Jun 25, 2020

chrisraygill Jun 25, 2020

chrisraygill Jun 25, 2020

zivkan Jun 28, 2020

chrisraygill commented Jun 25, 2020 •

edited

Loading

nkolev92 commented Jun 25, 2020

chrisraygill Jun 30, 2020

nkolev92 Jun 30, 2020

nkolev92 commented Jul 1, 2020


		## Goals

		Add an option to the command `add package` to enable installing latest prerelease version.

Add prerelease option to dotnet.exe add package command #9699

Add prerelease option to dotnet.exe add package command #9699

Conversation

martinrrm commented Jun 18, 2020

ghost commented Jun 18, 2020 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisraygill Jun 25, 2020 • edited Loading

Choose a reason for hiding this comment

zivkan commented Jun 19, 2020

nkolev92 commented Jun 20, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nkolev92 Jun 22, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wli3 commented Jun 22, 2020

chrisraygill commented Jun 23, 2020

nkolev92 commented Jun 23, 2020

wli3 commented Jun 23, 2020

nkolev92 commented Jun 25, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisraygill commented Jun 25, 2020 • edited Loading

nkolev92 commented Jun 25, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nkolev92 commented Jul 1, 2020

ghost commented Jun 18, 2020 •

edited by ghost

Loading

chrisraygill Jun 25, 2020 •

edited

Loading

nkolev92 commented Jun 20, 2020 •

edited

Loading

nkolev92 Jun 22, 2020 •

edited

Loading

chrisraygill commented Jun 25, 2020 •

edited

Loading