Developing Modern .NET Core Console Programs: (3) Publishing NuGet Packages to GitHub Packages

Preface

The previous article has already published the project template's NuGet package to the official NuGet source. However, it can also be published to other sources, such as GitHub. This article documents the process of publishing to GitHub Packages.

Note: This article is based on the second article in this series. For a better understanding of the operation process, please first familiarize yourself with the code structure of this project.

Creating a GitHub token

Visit the page https://github.com/settings/tokens

Generate a classic token

Remember to check the permissions related to packages (packages)

Add nuget source configuration to the project

Create a new nuget.config file in the src/Templates directory

<?xml version="1.0" encoding="utf-8"?>

<configuration>
    <packageSources>
        <clear />
        <add key="github" value="https://nuget.pkg.github.com/NAMESPACE/index.json" />
    </packageSources>
    <packageSourceCredentials>
        <github>
            <add key="Username" value="USERNAME" />
            <add key="ClearTextPassword" value="TOKEN" />
        </github>
    </packageSourceCredentials>
</configuration>

The above is just the configuration template provided by GitHub, with a few places that need to be modified:

• Replace USERNAME with the name of your personal account on GitHub.
• Replace TOKEN with a personal access token (classic).
• Replace NAMESPACE with the name of the personal account or organization used for package scoping (包限定范围).

Publish Package

Execute dotnet pack to generate a NuGet package

Then run the following command to publish the generated NuGet package to GitHub Packages

dotnet nuget push ".\bin\Release\FluentConsole.Templates.1.1.0.nupkg" --api-key TOKEN --source github

• TOKEN is the one you applied for earlier.

If everything goes well, you should see the following output:

Pushing FluentConsole.Templates.1.1.0.nupkg to 'https://nuget.pkg.github.com/Deali-Axy'...
  PUT https://nuget.pkg.github.com/Deali-Axy/
  OK https://nuget.pkg.github.com/Deali-Axy/ 1129 毫秒
Your package was pushed.

At this point, it's done. You can visit https://github.com/Deali-Axy?tab=packages to see the published packages.

Associating the Published Package with the Code Repository

Because the project address is https://github.com/Deali-Axy/fluent-dotnet-console

and the package name is FluentConsole.Templates

these two are inconsistent, so they will not be automatically associated. We need to perform the manual association.

Go to the package details page: https://github.com/users/Deali-Axy/packages/nuget/package/FluentConsole.Templates

Click the Connect Repository button below, and select the fluent-dotnet-console project.

After binding, the repository's README can be seen on the package's main page.

In the bottom right corner of the repository, you can also see this package.

PS: GitHub is becoming more and more user-friendly.

References

• https://docs.github.com/zh/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry