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

[IMPROVEMENT] Nuget Readme included in the package #790

Merged
merged 4 commits into from
Sep 28, 2023

Conversation

moljac
Copy link
Contributor

@moljac moljac commented Sep 24, 2023

Does this change any of the generated binding API's?

No.

Describe your contribution

NuGet best practices recommend adding readme.[txt,md] to each package. Otherwise following warning is emitted:

The package  is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important.

This PR adds readme.md to NuGet packages.

https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/

https://devblogs.microsoft.com/nuget/write-a-high-quality-readme-for-nuget-packages/

NuGet/Home#12070

https://raw.githubusercontent.com/lyndaidaii/NuGetReadMeTemplate/main/README.md

Verification

tree output/Xamarin.AndroidX.Wear.Compose.Navigation.1.2.0.1/

Result:

output/Xamarin.AndroidX.Wear.Compose.Navigation.1.2.0.1/
├── LICENSE.md
├── THIRD-PARTY-NOTICES.txt
├── Xamarin.AndroidX.Wear.Compose.Navigation.nuspec
├── [Content_Types].xml
├── _rels
├── aar
│   └── androidx.wear.compose.compose-navigation.aar
├── build
│   ├── monoandroid12.0
│   │   └── Xamarin.AndroidX.Wear.Compose.Navigation.targets
│   └── net6.0-android31.0
│       └── Xamarin.AndroidX.Wear.Compose.Navigation.targets
├── buildTransitive
│   ├── monoandroid12.0
│   │   └── Xamarin.AndroidX.Wear.Compose.Navigation.targets
│   └── net6.0-android31.0
│       └── Xamarin.AndroidX.Wear.Compose.Navigation.targets
├── icon.png
├── lib
│   ├── monoandroid12.0
│   │   ├── Xamarin.AndroidX.Wear.Compose.Navigation.dll
│   │   ├── Xamarin.AndroidX.Wear.Compose.Navigation.pdb
│   │   └── Xamarin.AndroidX.Wear.Compose.Navigation.xml
│   └── net6.0-android31.0
│       ├── Xamarin.AndroidX.Wear.Compose.Navigation.dll
│       ├── Xamarin.AndroidX.Wear.Compose.Navigation.pdb
│       └── Xamarin.AndroidX.Wear.Compose.Navigation.xml
├── package
│   └── services
│       └── metadata
│           └── core-properties
│               └── a2137d8722094644be43e3b1900c4cc1.psmdcp
├── proguard
│   └── proguard.txt
└── readme.md

17 directories, 19 files

@moljac moljac requested a review from jpobst September 28, 2023 09:05
@jonpryor
Copy link
Member

The **/*NuGetReadMe.cshtml files look nearly identical (are identical?). Is there a way to share these files to simplify future updates?

(These may need to be updated in the future, if/when we ever migrate to the dotnet org…)

@moljac
Copy link
Contributor Author

moljac commented Sep 28, 2023

The **/*NuGetReadMe.cshtml files look nearly identical (are identical?). Is there a way to share these files to simplify future updates?

"nearly identical" I would say. But some will be quite different. For example, for "no-bindings" group/template I need to add conditional description, because this group contains several completely different packages from different maven group ids and different authors.

It would be too much effort for now.

This PR is quick workaround to obey nuget's warnings about nice-to-haves.

(These may need to be updated in the future, if/when we ever migrate to the dotnet org…)

if and when priority of MAUI activities reduce.

@moljac moljac merged commit cf17927 into main Sep 28, 2023
@moljac moljac deleted the mu-20230922-nuget-readme branch September 28, 2023 11:31
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

Successfully merging this pull request may close these issues.

2 participants