An awesome template for your awesome library
- Follow the best and simplest patterns of build, pack and test with dotnet CLI.
- Init script that installs prerequisites and auth helpers, supporting both non-elevation and elevation modes.
- Static analyzers: FxCop and StyleCop
- Read-only source tree (builds to top-level bin/obj folders)
- Auto-versioning (via Nerdbank.GitVersioning)
- Builds with a "pinned" .NET Core SDK to ensure reproducible builds across machines and across time.
- Automatically pack the library and publish it as an artifact, and even push it to some NuGet feed for consumption.
- Testing
- Testing on .NET Framework, multiple .NET Core versions
- Testing on Windows, Linux and OSX
- Tests that crash or hang in Azure Pipelines automatically collect dumps and publish as a pipeline artifact for later investigation.
- Cloud build support
- YAML based build for long-term serviceability, and PR review opportunities for any changes.
- Azure Pipelines and GitHub Action support
- Emphasis on PowerShell scripts over reliance on tasks for a more locally reproducible build.
- Code coverage published to Azure Pipelines
- Code coverage published to codecov.io so GitHub PRs get code coverage results added as a PR comment
Once you've expanded this template for your own use, you should run the Expand-Template.ps1 script to customize the template for your own project.
Further customize your repo by:
- Verify the license is suitable for your goal as it appears in the LICENSE.md and stylecop.json files and the Directory.Build.props file's
PackageLicenseExpressionproperty. - Reset or replace the badges at the top of this file.
Use headings as required.