Skip to content
/ dotnet-library Public template

Template repo for a .NET library w/ GH Actions for build & publish

License

Notifications You must be signed in to change notification settings

johnkors/dotnet-library

Repository files navigation

dotnet-library

Sample badges

Build NuGet NuGet

What is this?

Template repo for setting up a simple .NET library (nuget) show casing some common use cases:

  • GitHub actions (CI, deploy)
    • CI : Restore, build & unit tests via Xunit
    • Pre-release:
      • Automated publishing of pre-release versions to nuget.org
      • Semver-versioning via GitVersion
      • Manually triggered workflow
    • Release:
      • Same as Pre-release, + publish a Github release w/ release notes using the GitHub Release Notes API.
  • A sensible .editorconfig for csharp
  • A sensible .gitignorefor .NET projects
  • Commonly setup Nuget package contents:
    • Package icon (embedded in nuget)
    • Readme showing in nuget.org (embedded in nuget),
    • Multi-targeting and conditional dependencies dep on TFM
  • Funding for GitHub Sponsors
  • MIT License