How to publish readme file automatically along with package in NuGet org through GitHub actions CI/CD pipeline

Question

Details about Problem

When uploading a package to nuget.org manually via the website, I can set a documentation URL that points to a readme file on github, as shown here: https://www.nuget.org/packages/blazor-server-githubactions-demo/ How do I this via a .csproject file, as I use CI / CD to publish my packages and so I don't want this to be a manual step. how publish readme file automatically along with pacakge.

Answer 1

I didn't try, but according to this blog post from Microsoft, I'd expect the following to work

1. Create README.md in your repo.
2. Ensure your csproj file looks like this:

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        ...
        <PackageReadmeFile>README.md</PackageReadmeFile>
        ...
    </PropertyGroup>

    <ItemGroup>
        ...
        <None Include="docs\README.md" Pack="true" PackagePath="\"/>
        ...
    </ItemGroup>
</Project>

This should configure everything in your NuGet package, so that it gets picked up when being uploaded to nuget.org.