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

[Feature Request] Publish docfx packages in the name of .NET foundation #8930

Closed
13 tasks done
yufeih opened this issue Jul 4, 2023 · 8 comments
Closed
13 tasks done
Milestone

Comments

@yufeih
Copy link
Contributor

yufeih commented Jul 4, 2023

Today docfx NuGet packages are published in the name of Microsoft. With the transition to .NET foundation, future versions of docfx will be published in the name of .NET foundation.

This will introduce a breaking change to all packages starting with Microsoft.*, as those packages can only be published with a Microsoft signing cert. The candidate new package and namespace naming conventions are: Microsoft.DocAsCode.* -> Docfx.* or Microsoft.DocAsCode.* -> DocAsCode.*


@KalleOlaviNiemitalo
Copy link

There are already third-party packages prefixed with "DocAsCode.":

Microsoft.DocAsCode.Dfm is fortunately already dead and won't have to be renamed to DocAsCode.Dfm, which would conflict with the third-party package.

There are also third-party packages prefixed with "DocFX.":

and some prefixed with just "DocFX" without a dot:

I don't know why there are so many DocFx.Plugins.PlantUmldigits packages, or why they were published in September 2022 even though the latest commit in the https://github.com/KevReed/DocFx.Plugins.PlantUml repository is from May 2020.

Will users be confused if official DocFX packages and third-party packages have the same prefix?
Do the third-party packages affect whether you can reserve the prefix in NuGet Gallery?

@yufeih
Copy link
Contributor Author

yufeih commented Jul 6, 2023

It appears we could reserve Docfx.* and leave Docfx.Plugins.* as public, which make sense to me as a naming convention for 3rd party plugins.

@KalleOlaviNiemitalo
Copy link

Reserve package prefix on NuGet.org: DocFx.* prefix is now owned by the docfx account leaving DocFx.Plugins.* public

Why does https://www.nuget.org/packages/docfx show "Prefix Reserved" even though the "docfx" name does not include the dot that is in the "DocFX.*" prefix?

@yufeih
Copy link
Contributor Author

yufeih commented Jul 15, 2023

I don't have exact details on how NuGet name reserve works. It seems reserving the Docfx.* prefix did make docfx prefix reserved but does not reserve package names starting with docfx such as docfxabc.

@Lulalaby
Copy link
Contributor

Lulalaby commented Jul 27, 2023

Why does https://www.nuget.org/packages/docfx show "Prefix Reserved" even though the "docfx" name does not include the dot that is in the "DocFX.*" prefix?

If someone requests a namespace reservation for namespace.* the NuGet team reserves namespace. as wildcard and additionally namespace as single package name.

i.e.:
image

@yufeih
Copy link
Contributor Author

yufeih commented Jul 29, 2023

Newer versions of Docfx.* packages have been published to NuGet.org successfully. The docfx package is pushed to NuGet but failed package validation due to signing cert change. Need to work with NuGet team together to get it fixed.

@yufeih
Copy link
Contributor Author

yufeih commented Aug 2, 2023

The v2.70.0 release is out and fully on .NET foundation 🚀

@yufeih yufeih closed this as completed Aug 2, 2023
@Lulalaby
Copy link
Contributor

Lulalaby commented Aug 2, 2023

Congrats! Happy that this is finally done ❤️🚀

p-kostov pushed a commit to ErpNetDocs/docfx that referenced this issue Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants