Skip to content
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

Document machine readable json output for dotnet list package report #32855

Merged

Conversation

erdembayar
Copy link
Contributor

@erdembayar erdembayar commented Dec 2, 2022

Fixes: https://github.com/NuGet/docs.microsoft.com-nuget/issues/2922
Related to: dotnet/sdk#29367, NuGet/Home#7752

Spec is here. New command option can be used like below:
dotnet list package --format json
dotnet list package --format json --output-version 1

!!! Don't merge before we verify it's available in GA sdk version.

Copy link
Contributor

@nkolev92 nkolev92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to document the format somehow/somewhere?

@erdembayar
Copy link
Contributor Author

Do we want to document the format somehow/somewhere?

Do you mean something like blog post which explains usage in detail?

@nkolev92
Copy link
Contributor

nkolev92 commented Dec 3, 2022

Do we want to document the format somehow/somewhere?

Do you mean something like blog post which explains usage in detail?

Not really. More of a schema for the file somewhere that's not our designs.
People would need to know how to parse things.

Copy link
Contributor

@tdykstra tdykstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, one suggestion

docs/core/tools/dotnet-list-package.md Outdated Show resolved Hide resolved
@BillWagner
Copy link
Member

Tom's comments have all been addressed.

I'll :shipit: now.

@BillWagner BillWagner merged commit 3b17377 into main Jan 6, 2023
@BillWagner BillWagner deleted the dev-eryondon-dotnet-list-package-machinereadableoutput branch January 6, 2023 16:02
@erdembayar
Copy link
Contributor Author

erdembayar commented Jan 12, 2023

@BillWagner
My change is going into .NET sdk 7.0.2xx not in .NET sdk 7.0.102, it looks like this PR merged prematurely, not causing some confusion. Could we revert this one? I should have specified it's .NET sdk 7.0.2xx version in my description. I didn't know it went live this soon.

erdembayar added a commit that referenced this pull request Jan 13, 2023
BillWagner pushed a commit that referenced this pull request Jan 13, 2023
erdembayar added a commit that referenced this pull request Jan 13, 2023
…t for dotnet list package report (#32855)" (#33516)"

This reverts commit 8643439.
tdykstra pushed a commit that referenced this pull request Feb 18, 2023
…t for dotnet list package report (#32855)" (#33516)" (#33518)

This reverts commit 8643439.
@tdykstra
Copy link
Contributor

Do we want to document the format somehow/somewhere?

Do you mean something like blog post which explains usage in detail?

Not really. More of a schema for the file somewhere that's not our designs. People would need to know how to parse things.

@nkolev92 @erdembayar We have an issue now asking for the format (#38022) is that information available somewhere?

@nkolev92
Copy link
Contributor

We have a tracking issue for that (it was internal, so I moved it to an external one) NuGet/Home#13503.

The source of truth is https://github.com/NuGet/Home/blob/dev/proposed/2022/DotnetListPackageMachineReadableJsonOutput.md.
It's not quite written ina schema way, but it contains all the examples.

@erdembayar
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create dotnet list package json output command document
7 participants