MiniScaffold

What is MiniScaffold?

This is an F# Template for:

• creating and publishing libraries targeting .NET 8.0 net8.0
• creating and publishing applications with the target framework from the application project

Why use MiniScaffold?

This takes away the ambiguity that developers face when creating an OSS project. Such as:

• How do I structure my project?
• How do I create repeatable builds?
• Which test framework should I use?
• How to I create releases?
• What Issue/Pull Request templates should I use?
• How should I go about creating documentation?
• How do I setup CI?
• What's the standard .gitignore file?
• What other things would make it easier for me when starting off creating a project I might not even know about?

What does this include in the box?

All project types

• Standard project structure for your dotnet application
• Build Automation tool via FAKE
• Package management tool via Nuget
• Unit Testing via Expecto
• Code Coverage via Altcover
  • Also builds an html report with ReportGenerator
• Code formatting style via Fantomas
• Release build step commits latest CHANGELOG.md in the body and creates a git tag.
  • If you reference a Pull Request in the CHANGELOG.md it will update that Pull Request with the version it was released in.
• Release build step publishes a GitHub Release via the CHANGELOG.md and adds any artifacts (nuget/zip/targz/etc).
• Continuous integration via GitHub Actions

For Libraries

• Builds for net8.0 - Target Frameworks
  • To build for net8.0 .NET 8.0 installed
• Sourcelink which enables a great source debugging experience for your users, by adding source control metadata to your built assets
• Documentation Generation - Generates Documentation from markdown files, fsx files, and the XML Documentation Comments from your library.
• Release build step pushes NuGet packages to NuGet
  • Generates Package Version from CHANGELOG.md
  • Adds Package Release Notes metadata from CHANGELOG.md

For Applications

• Basic argument parsing example via Argu
• Builds the target framework from the application project.
• Uses dotnet publish to create framework-dependent applications for Windows, macOS, and Linux.
• Supports x64 and ARM64 architectures.
• Creates six ZIP archives in dist/ with names of the form <product>-<version>-<runtime>.zip.
• Places the executable and supporting files at each archive root.
• Requires the corresponding .NET runtime on the destination computer.

Getting started quickly

Install the dotnet template from NuGet:

dotnet new -i "MiniScaffold::*"

I want to build a library

dotnet new mini-scaffold -n MyCoolNewLib --githubUsername MyGithubUsername

I want to build a console application

dotnet new mini-scaffold -n MyCoolNewApp --githubUsername MyGithubUsername -ou console