Skip to content

Add descriptive information about dotnet-quality #635

Open
@avengerx

Description

@avengerx

Description:
Add a little more info on each quality in the related documentation section. Returning users can get really lost with these.

At the time of writing this issue, we had in src/setup-dotnet.ts:12-18:

const qualityOptions = [
  'daily',
  'signed',
  'validated',
  'preview',
  'ga'
] as const;

And in the documentation:

We could expand to have something like:

daily: The latest builds of the SDK or Runtime. They're built every day and aren't tested. They aren't recommended for production use but can often be used to test specific features or fixes immediately after they are merged into the product. These builds are from the dotnet/installer repo, and so if you're looking for fixes from dotnet/sdk you must wait for code to flow and be merged from SDK to Installer before it appears in a daily build.
signed: I have no idea
validated: what's that?
preview: The monthly public releases of the next version of .NET, intended for public use. Not recommended for production use. Intended to allow users to experiment and test the new major version before release.
ga: The final stable releases of the .NET SDK and Runtime. Intended for public use as well as production support.

Justification:
I had to google around until I found https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-install-script with (hopefully) information about most of the options. Well, 3 is over half of 5, right? :) Most.
I think this is not something that's going to change so often and clarifying what each option does should help a lot. I've seen issues with people using "quality" as "release". I would also do that if I followed my intuition.

Are you willing to submit a PR?
Sure. But I lack all information needed to fill in all the gaps. Would take a bit more research to find them out.

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature requestNew feature or request to improve the current logic

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions