dotnet-apiport
dotnet-apiport copied to clipboard
microsoft
Publish the client as a .NET Core global tool
https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools
It makes it easier to consume for developers.
@terrajobst I planned to work on some report related improvement work items first since we have heard some customer feedback. Have we hears customer requests for this issue? If so, we can certainly prioritize this.
The benefit of doing it this way is that customers can get updates more quickly. Many people are still confused on how to acquire it. I keep getting pinged on why it's not a Global Tool yet, both from internal as well as external people.
@KathleenDollard @danroth27
If it is a .NET Core shared framework dll, then creating a global tool is a fairly painless process, although creating a signed build (required) may not be.
If it is a shared framework dll already, I can help with the syntax of the CLI and naming, and with the System.CommandLine parser. With this, I think the work to create the tool will be smallish.
If it is not a shared framework dll, that would be a problem.
@KathleenDollard It is not shared framework dll. It is only released in a zip file from this repo. That is the pain point that we want to address.
@KathleenDollard is https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools-how-to-create the document that I should follow to create a global tool?
That is a good start. I am working on another document for MSFT authored tools. Here are additional comments.
- All .NET (Global) Tools are framework dependent executables * We are working on guidelines for 2.1/3.0. Suggest testing on both and Muti-targeting
- Highly recommend you create your help in word or markdown first * It should parallel dotnet --help * I highly recommend you review this syntax with me for consistency
- Highly recommend you use System.CommandLine for parsing. See https://github.com/dotnet/command-line-api * Jon Sequeira can answer questions
- Signing is required. William Li may be able to help some
- The package name must be prefixed with "Microsoft". You must also reserve the non-Microsoft prefixed version.
I'm happy to schedule some time with you on this. I am out Friday and next week. I come in early if you are an early person.
From: Alicia Li [email protected] Sent: Friday, July 12, 2019 4:14 PM To: microsoft/dotnet-apiport [email protected] Cc: Kathleen Dollard [email protected]; Mention [email protected] Subject: Re: [microsoft/dotnet-apiport] Publish the client as a .NET Core global tool (#668)
@KathleenDollardhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FKathleenDollard&data=02%7C01%7Ckathleen.dollard%40microsoft.com%7C50a41ffbf02043afbdf208d7071eb26f%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636985700733592562&sdata=CxVXFnq3Jkdl811jVB9YWtPTxxOtucHrAW1CNXoQPfw%3D&reserved=0 is https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools-how-to-createhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Fdotnet%2Fcore%2Ftools%2Fglobal-tools-how-to-create&data=02%7C01%7Ckathleen.dollard%40microsoft.com%7C50a41ffbf02043afbdf208d7071eb26f%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636985700733602557&sdata=nIkG6lCS77b6BogJjR%2FpRdI8KC0aPXZ5ZvrvTrTdQ6c%3D&reserved=0 the document that I should follow to create a global tool?
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmicrosoft%2Fdotnet-apiport%2Fissues%2F668%3Femail_source%3Dnotifications%26email_token%3DABMS2XQC7LWMQH2JZZT76Z3P7EF5NA5CNFSM4FCXCGD2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZ3CR5A%23issuecomment-511060212&data=02%7C01%7Ckathleen.dollard%40microsoft.com%7C50a41ffbf02043afbdf208d7071eb26f%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636985700733612552&sdata=qwmze54DiZlej%2BDZ5S5EUcpx%2BTIyI5a%2FYc1zZsUdivg%3D&reserved=0, or mute the threadhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FABMS2XUMQRQI2ZQML7Y65MDP7EF5NANCNFSM4FCXCGDQ&data=02%7C01%7Ckathleen.dollard%40microsoft.com%7C50a41ffbf02043afbdf208d7071eb26f%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636985700733612552&sdata=Zn9Dabx1%2FvKz%2BgDnT%2BZn2mEPu8KBPMU7iRO7fINuSjI%3D&reserved=0.
@KathleenDollard I have created a PR https://github.com/microsoft/dotnet-apiport/pull/790 for this. Somehowever I can add you as reviewer.