Skip to content

pleonex/template-csharp

Repository files navigation

.NET project template

Stable version   GitHub commits since latest release (by SemVer)   Build and release   MIT License  

Repository template for .NET projects with a complete DevOps workflow. It uses the build system and best-practices from PleOps.Cake.

  • ♻️ DevOps best practices for a software project
  • 🔧 Build, test and release .NET projects
  • 📚 Documentation
  • 🤖 Continuous integration

Tech stack

  • Projects: C# / .NET
  • Documentation: DocFX, GitHub page
  • CI: GitHub Actions
  • Release deployment: NuGet feeds, GitHub

Get started

Follow the setup guide started guide from PleOps.Cake to adapt this template to your project.

Feel free to ask any question in the PleOps.Cake project discussion.

Build

The project requires to build .NET 8.0 SDK.

To build, test and generate artifacts run:

# Build and run tests (with code coverage!)
dotnet run --project build/orchestrator

# (Optional) Create bundles (nuget, zips, docs)
dotnet run --project build/orchestrator -- --target=Bundle

Release

Create a new GitHub release with a tag v{Version} (e.g. v2.4) and that's it! This triggers a pipeline that builds and deploy the project.