MiniScaffold 0.37.1

dotnet new install MiniScaffold::0.37.1
This package contains a .NET 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/CD 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 install "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.37.1 3,287 11/19/2023
0.37.0 808 10/25/2023
0.36.2 235 10/22/2023
0.36.1 175 10/21/2023
0.36.0 683 10/6/2023
0.35.2 211 9/18/2023
0.35.0 149 9/18/2023
0.34.2 194 9/14/2023
0.34.1 141 9/5/2023
0.34.0 368 6/9/2023
0.33.0 126 6/7/2023
0.33.0-alpha009 151 6/7/2023
0.33.0-alpha008 126 6/7/2023
0.33.0-alpha007 152 6/7/2023
0.33.0-alpha006 168 6/7/2023
0.33.0-alpha005 159 6/7/2023
0.33.0-alpha004 126 6/7/2023
0.32.0 940 9/17/2022
0.32.0-beta001 190 9/17/2022
0.31.1 604 4/29/2022
0.31.1-beta001 181 4/29/2022
0.31.0 514 2/6/2022
0.31.0-beta001 221 2/6/2022
0.30.0 478 1/18/2022
0.30.0-beta001 153 1/18/2022
0.29.1 460 10/11/2021
0.29.1-beta001 209 10/11/2021
0.29.0 368 9/29/2021
0.29.0-beta001 186 9/29/2021
0.28.0 2,435 6/3/2021
0.27.0 369 5/28/2021
0.27.0-beta002 218 5/28/2021
0.27.0-beta001 185 5/28/2021
0.26.4 393 5/25/2021
0.26.4-beta001 229 5/25/2021
0.26.3 548 3/14/2021
0.26.3-beta001 277 3/14/2021
0.26.2 524 1/22/2021
0.26.1 436 1/19/2021
0.26.1-beta001 239 1/19/2021
0.26.0 444 1/5/2021
0.26.0-beta001 220 1/5/2021
0.25.1 520 11/11/2020
0.25.0 754 7/25/2020
0.25.0-beta001 333 7/25/2020
0.24.4 620 5/9/2020
0.24.3 569 5/9/2020
0.24.2 585 5/1/2020
0.24.1 530 4/23/2020
0.24.0 552 3/26/2020
0.23.5 545 3/24/2020
0.23.4 556 3/8/2020
0.23.3 581 2/24/2020
0.23.2 526 2/24/2020
0.23.1 538 2/24/2020
0.23.0 567 2/13/2020
0.23.0-beta001 379 2/7/2020
0.22.4 669 1/23/2020
0.22.3 583 1/15/2020
0.22.2 593 1/3/2020
0.22.1 609 12/26/2019
0.22.0 614 12/26/2019
0.22.0-beta001 425 12/26/2019
0.21.5 576 12/24/2019
0.21.4-beta001 410 12/24/2019
0.21.3 575 12/21/2019
0.21.2 582 12/21/2019
0.21.1 583 12/16/2019
0.21.0 567 12/13/2019
0.20.2 593 12/13/2019
0.20.1 582 11/26/2019
0.20.0 587 10/22/2019
0.19.2 567 10/22/2019
0.19.1 570 10/21/2019
0.19.0 595 9/24/2019
0.18.0 585 9/20/2019
0.17.1 809 6/4/2019
0.16.4 697 5/20/2019
0.16.3 640 5/17/2019
0.16.2 640 5/17/2019
0.16.1 623 5/9/2019
0.16.0 661 5/8/2019
0.15.1 770 5/3/2019
0.15.0 736 5/2/2019
0.14.2 709 5/2/2019
0.14.2-beta002 528 5/2/2019
0.14.2-beta001 533 5/2/2019
0.14.1 720 4/9/2019
0.14.0 875 2/19/2019
0.14.0-beta001 546 2/18/2019
0.13.0 880 1/9/2019
0.12.1 740 1/9/2019
0.12.0 1,059 9/11/2018
0.11.0 808 8/30/2018
0.11.0-beta002 578 8/30/2018
0.11.0-beta001 584 8/30/2018
0.10.0 896 8/18/2018
0.9.7 883 8/18/2018
0.9.6 859 8/10/2018
0.9.5 1,034 7/9/2018
0.9.4 1,067 6/22/2018
0.9.3 1,137 6/1/2018
0.9.2 1,060 6/1/2018
0.9.1 1,110 5/15/2018
0.9.0 1,090 5/14/2018
0.8.1 1,121 4/9/2018
0.8.0 1,172 3/20/2018
0.8.0-alpha002 817 3/20/2018
0.8.0-alpha001 879 3/20/2018
0.7.1 1,094 3/20/2018
0.7.0 1,094 3/16/2018
0.6.1 1,081 3/11/2018
0.6.0 1,080 3/7/2018
0.6.0-beta001 848 3/6/2018
0.5.2 1,100 3/1/2018
0.5.2-beta001 847 2/25/2018
0.5.1 1,077 2/25/2018
0.5.1-beta001 835 2/25/2018
0.5.0 1,162 2/15/2018
0.5.0-beta004 843 2/12/2018
0.5.0-beta003 852 2/12/2018
0.5.0-beta002 864 2/12/2018
0.5.0-beta001 843 2/10/2018
0.4.1 1,137 2/10/2018
0.4.1-beta003 860 2/10/2018
0.4.1-beta002 1,115 2/9/2018
0.4.1-beta001 863 2/9/2018
0.4.0 1,117 1/13/2018
0.3.5 1,482 7/18/2017
0.3.4 1,079 7/3/2017
0.3.3 1,110 6/26/2017
0.3.2 1,127 5/7/2017
0.3.2-alpha001 872 5/2/2017
0.3.1 1,056 4/30/2017
0.3.0 1,059 4/30/2017
0.3.0-alpha001 806 4/30/2017
0.2.0 1,156 4/18/2017
0.2.0-alpha001 815 4/18/2017
0.1.0 1,104 4/14/2017
0.1.0-alpha008 796 4/14/2017
0.1.0-alpha007 789 4/14/2017
0.1.0-alpha006 783 4/14/2017
0.1.0-alpha005 823 4/14/2017
0.1.0-alpha004 803 4/14/2017
0.1.0-alpha003 812 4/14/2017
0.1.0-alpha002 842 4/14/2017
0.1.0-alpha001 847 4/14/2017

## [0.37.1] - 2023-11-19

[0.37.1]: https://github.com/TheAngryByrd/MiniScaffold//compare/v0.37.0...v0.37.1

### Fixed
- [Use GitHub Environments for Nuget Publish](https://github.com/TheAngryByrd/MiniScaffold/pull/285) from @PolinaSavelyeva