-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Doc/packages sourcing #8475
Doc/packages sourcing #8475
Conversation
Pretty pictures! Should this (and the RARaaS doc) be in documentation/specs instead of documentation/design? |
Thanks :-) - the hand scetch is just temp before I collect feedback and create diagram in something more appropriate documentation/specs - seems to be rather for already exisiting features - so I would keep this one out for now |
3afd07b
to
26bd1b8
Compare
|
||
# North Star / Longer-term vision | ||
|
||
We envision the 'packages sourcing' to be a first-class-citizen within nuget client (and hence [`dotnet restore`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-restore)). Via denoting specific metadata on `PackageReference` it would be possible to perform specific mode of restore operation for the particular package reference - by pointing to a local sources, or letting the command to figure out and fetch apropriate sources: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a gap in understanding on the requirement/user-scenario here? Can that be updated before we talk about the north-star of the feature itself?
For example, should developer be required to make changes to the csproj PackageReference
or should it be a command line option to msbuild/nuget.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/cc: @baronfel
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we move the User Scenarios section to the top - would that address the concern?
UX - Manual edit of PackageReference
vs a CLI option (vs VS GUI, vs anything else) - great point! Though I would prefer avoiding a single firm decision on that now, unitl a PoC/spike (that this doc is mainly shooting for, north-star is for context) is alive and viability and limitations are better qualified and quantified
* **Supporting nuget packages that are not `SourceLink` enabled**. As a fallback we might use `SourceLink` stamped symbols, but unless the `SourceLink` information is to be found either within the nuget package or published matching symbols, this feature will not be enabled. | ||
* **Custom pre-build prerequisities**. First version of the feature will make several assumptions on common ways to build packages from source repository (attempt to build just the project with `dotnet build`, attempt to locate `*.sln` or `build.<cmd|sh|ps1>` script or existence of reproducible build compiler flags) | ||
|
||
# User scenarios |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it might be good to include specific actions Alice and Bob need to do in order to enable the new feature.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree. I'll edit after prototyping phase once the exact actions are formalized
Preliminary design proposal for the Packages Sourcing feature
Preliminary design proposal for the Packages Sourcing feature
Related to #8399
Context
Preliminary design proposal for the Packages Sourcing feature
This PR is meant to be a form of design review