MiniScaffold 0.31.1

dotnet new --install MiniScaffold::0.31.1
This package contains a .NET Core Template Package you can call from the shell/command line.

MiniScaffold

What is MiniScaffold?

This is an F# Template for:

  • creating and publishing libraries targeting .NET 6.0 net6.0
  • creating and publishing applications targeting .NET 6.0 net6.0

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 do I create releases easily?
  • What Issue/Pull Request templates should I use?
  • How should I go about creating documentation?
  • How do I get CI setup easily?
  • 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

For Libraries

For Applications

  • Basic argument parsing example via Argu
  • Builds a net6.0 application - Target Frameworks
    • To build for net6.0
  • Builds for win-x64, osx-x64 and linux-x64 - Runtime Identifiers. Bundles the application via dotnet-packaging
    • Bundles the win-x64 application in a .zip file.
    • Bundles the osx-x64 application in a .tar.gz file.
    • Bundles the linux-x64 application in a .tar.gz file.

Getting started quickly

Install the dotnet template from NuGet:

dotnet new -i "MiniScaffold::*"

Then choose:

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

The scaffold defaults to using the main branch for releases. If you release from a different branch, you can use the --releaseBranch <branch name> parameter to use your release branch instead of the default.


Builds

GitHub Actions
GitHub Actions
Build History

NuGet

Stable Prerelease
NuGet Badge NuGet Badge

Options

githubUserName

This is used to automatically configure author information in the NuGet package, as well as configure push urls for repo locations.

outputType

Defaults to Library

When set to either Console or Library project and the supporting infrastructure around their respective types.


Known issues

Permission denied

-bash: ./build.sh: Permission denied

This is because dotnet template loses permissions of files. (https://github.com/TheAngryByrd/MiniScaffold/pull/37) added a post hook to address this but this only fixes it for dotnet sdk 2.x users. dotnet sdk 1.x will need to run chmod +x ./build.sh

Appveyor badge not scaffolded correctly

Appveyor's conventions around generating URLs based on the project name has some nuances. See this issue for details.


Example Projects using this template:
This project uses the following projects:
  • .NETStandard 0.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.31.1 111 4/29/2022
0.31.1-beta001 44 4/29/2022
0.31.0 128 2/6/2022
0.31.0-beta001 38 2/6/2022
0.30.0 95 1/18/2022
0.30.0-beta001 46 1/18/2022
0.29.1 265 10/11/2021
0.29.1-beta001 135 10/11/2021
0.29.0 173 9/29/2021
0.29.0-beta001 109 9/29/2021
0.28.0 2,228 6/3/2021
0.27.0 162 5/28/2021
0.27.0-beta002 113 5/28/2021
0.27.0-beta001 116 5/28/2021
0.26.4 191 5/25/2021
0.26.4-beta001 151 5/25/2021
0.26.3 326 3/14/2021
0.26.3-beta001 208 3/14/2021
0.26.2 300 1/22/2021
0.26.1 214 1/19/2021
0.26.1-beta001 171 1/19/2021
0.26.0 248 1/5/2021
0.26.0-beta001 155 1/5/2021
0.25.1 310 11/11/2020
0.25.0 532 7/25/2020
0.25.0-beta001 261 7/25/2020
0.24.4 400 5/9/2020
0.24.3 339 5/9/2020
0.24.2 341 5/1/2020
0.24.1 307 4/23/2020
0.24.0 323 3/26/2020
0.23.5 340 3/24/2020
0.23.4 342 3/8/2020
0.23.3 354 2/24/2020
0.23.2 299 2/24/2020
0.23.1 305 2/24/2020
0.23.0 340 2/13/2020
0.23.0-beta001 303 2/7/2020
0.22.4 433 1/23/2020
0.22.3 353 1/15/2020
0.22.2 364 1/3/2020
0.22.1 371 12/26/2019
0.22.0 393 12/26/2019
0.22.0-beta001 346 12/26/2019
0.21.5 360 12/24/2019
0.21.4-beta001 324 12/24/2019
0.21.3 336 12/21/2019
0.21.2 351 12/21/2019
0.21.1 350 12/16/2019
0.21.0 346 12/13/2019
0.20.2 363 12/13/2019
0.20.1 357 11/26/2019
0.20.0 372 10/22/2019
0.19.2 340 10/22/2019
0.19.1 337 10/21/2019
0.19.0 368 9/24/2019
0.18.0 362 9/20/2019
0.17.1 579 6/4/2019
0.16.4 450 5/20/2019
0.16.3 402 5/17/2019
0.16.2 403 5/17/2019
0.16.1 409 5/9/2019
0.16.0 413 5/8/2019
0.15.1 526 5/3/2019
0.15.0 520 5/2/2019
0.14.2 499 5/2/2019
0.14.2-beta002 448 5/2/2019
0.14.2-beta001 459 5/2/2019
0.14.1 471 4/9/2019
0.14.0 642 2/19/2019
0.14.0-beta001 468 2/18/2019
0.13.0 644 1/9/2019
0.12.1 508 1/9/2019
0.12.0 813 9/11/2018
0.11.0 572 8/30/2018
0.11.0-beta002 492 8/30/2018
0.11.0-beta001 494 8/30/2018
0.10.0 648 8/18/2018
0.9.7 621 8/18/2018
0.9.6 614 8/10/2018
0.9.5 767 7/9/2018
0.9.4 781 6/22/2018
0.9.3 842 6/1/2018
0.9.2 771 6/1/2018
0.9.1 815 5/15/2018
0.9.0 804 5/14/2018
0.8.1 819 4/9/2018
0.8.0 860 3/20/2018
0.8.0-alpha002 689 3/20/2018
0.8.0-alpha001 742 3/20/2018
0.7.1 780 3/20/2018
0.7.0 811 3/16/2018
0.6.1 778 3/11/2018
0.6.0 796 3/7/2018
0.6.0-beta001 721 3/6/2018
0.5.2 794 3/1/2018
0.5.2-beta001 706 2/25/2018
0.5.1 773 2/25/2018
0.5.1-beta001 703 2/25/2018
0.5.0 864 2/15/2018
0.5.0-beta004 714 2/12/2018
0.5.0-beta003 691 2/12/2018
0.5.0-beta002 719 2/12/2018
0.5.0-beta001 704 2/10/2018
0.4.1 832 2/10/2018
0.4.1-beta003 715 2/10/2018
0.4.1-beta002 977 2/9/2018
0.4.1-beta001 727 2/9/2018
0.4.0 821 1/13/2018
0.3.5 1,193 7/18/2017
0.3.4 806 7/3/2017
0.3.3 829 6/26/2017
0.3.2 867 5/7/2017
0.3.2-alpha001 738 5/2/2017
0.3.1 739 4/30/2017
0.3.0 759 4/30/2017
0.3.0-alpha001 681 4/30/2017
0.2.0 874 4/18/2017
0.2.0-alpha001 703 4/18/2017
0.1.0 819 4/14/2017
0.1.0-alpha008 678 4/14/2017
0.1.0-alpha007 661 4/14/2017
0.1.0-alpha006 667 4/14/2017
0.1.0-alpha005 706 4/14/2017
0.1.0-alpha004 692 4/14/2017
0.1.0-alpha003 691 4/14/2017
0.1.0-alpha002 692 4/14/2017
0.1.0-alpha001 698 4/14/2017

## [0.31.1] - 2022-04-29

[0.31.1]: https://github.com/TheAngryByrd/MiniScaffold/compare/0.31.0...0.31.1

### Fixed
- [Adjust Dockerfiles to copy install-dotnets.sh correctly on new versions of Docker.](https://github.com/TheAngryByrd/MiniScaffold/pull/257)