MiniScaffold 0.29.0-beta001

This is a prerelease version of MiniScaffold.
There is a newer version of this package available.
See the version list below for details. 
dotnet new install MiniScaffold::0.29.0-beta001
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 5.0 net5.0
  • creating and publishing applications targeting .NET 5.0 net5.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 Libraries

For Applications

  • Basic argument parsing example via Argu
  • Builds a net5.0 application - Target Frameworks
    • To build for net5.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.38.0 165 12/7/2024
0.38.0-beta001 95 12/7/2024
0.37.1 3,602 11/19/2023
0.37.0 869 10/25/2023
0.36.2 301 10/22/2023
0.36.1 239 10/21/2023
0.36.0 742 10/6/2023
0.35.2 278 9/18/2023
0.35.0 220 9/18/2023
0.34.2 260 9/14/2023
0.34.1 206 9/5/2023
0.34.0 423 6/9/2023
0.33.0 177 6/7/2023
0.33.0-alpha009 211 6/7/2023
0.33.0-alpha008 184 6/7/2023
0.33.0-alpha007 215 6/7/2023
0.33.0-alpha006 227 6/7/2023
0.33.0-alpha005 220 6/7/2023
0.33.0-alpha004 183 6/7/2023
0.32.0 997 9/17/2022
0.32.0-beta001 272 9/17/2022
0.31.1 697 4/29/2022
0.31.1-beta001 279 4/29/2022
0.31.0 598 2/6/2022
0.31.0-beta001 313 2/6/2022
0.30.0 548 1/18/2022
0.30.0-beta001 233 1/18/2022
0.29.1 536 10/11/2021
0.29.1-beta001 272 10/11/2021
0.29.0 448 9/29/2021
0.29.0-beta001 254 9/29/2021
0.28.0 2,512 6/3/2021
0.27.0 456 5/28/2021
0.27.0-beta002 286 5/28/2021
0.27.0-beta001 254 5/28/2021
0.26.4 466 5/25/2021
0.26.4-beta001 292 5/25/2021
0.26.3 623 3/14/2021
0.26.3-beta001 347 3/14/2021
0.26.2 608 1/22/2021
0.26.1 517 1/19/2021
0.26.1-beta001 312 1/19/2021
0.26.0 528 1/5/2021
0.26.0-beta001 295 1/5/2021
0.25.1 609 11/11/2020
0.25.0 854 7/25/2020
0.25.0-beta001 408 7/25/2020
0.24.4 711 5/9/2020
0.24.3 668 5/9/2020
0.24.2 672 5/1/2020
0.24.1 620 4/23/2020
0.24.0 646 3/26/2020
0.23.5 637 3/24/2020
0.23.4 645 3/8/2020
0.23.3 686 2/24/2020
0.23.2 615 2/24/2020
0.23.1 627 2/24/2020
0.23.0 666 2/13/2020
0.23.0-beta001 465 2/7/2020
0.22.4 763 1/23/2020
0.22.3 671 1/15/2020
0.22.2 693 1/3/2020
0.22.1 700 12/26/2019
0.22.0 718 12/26/2019
0.22.0-beta001 515 12/26/2019
0.21.5 679 12/24/2019
0.21.4-beta001 491 12/24/2019
0.21.3 673 12/21/2019
0.21.2 683 12/21/2019
0.21.1 685 12/16/2019
0.21.0 659 12/13/2019
0.20.2 692 12/13/2019
0.20.1 674 11/26/2019
0.20.0 685 10/22/2019
0.19.2 658 10/22/2019
0.19.1 658 10/21/2019
0.19.0 688 9/24/2019
0.18.0 675 9/20/2019
0.17.1 904 6/4/2019
0.16.4 794 5/20/2019
0.16.3 730 5/17/2019
0.16.2 730 5/17/2019
0.16.1 719 5/9/2019
0.16.0 773 5/8/2019
0.15.1 861 5/3/2019
0.15.0 836 5/2/2019
0.14.2 802 5/2/2019
0.14.2-beta002 613 5/2/2019
0.14.2-beta001 621 5/2/2019
0.14.1 821 4/9/2019
0.14.0 970 2/19/2019
0.14.0-beta001 635 2/18/2019
0.13.0 978 1/9/2019
0.12.1 846 1/9/2019
0.12.0 1,188 9/11/2018
0.11.0 946 8/30/2018
0.11.0-beta002 692 8/30/2018
0.11.0-beta001 699 8/30/2018
0.10.0 1,029 8/18/2018
0.9.7 1,011 8/18/2018
0.9.6 982 8/10/2018
0.9.5 1,288 7/9/2018
0.9.4 1,308 6/22/2018
0.9.3 1,389 6/1/2018
0.9.2 1,307 6/1/2018
0.9.1 1,386 5/15/2018
0.9.0 1,342 5/14/2018
0.8.1 1,378 4/9/2018
0.8.0 1,431 3/20/2018
0.8.0-alpha002 1,062 3/20/2018
0.8.0-alpha001 1,120 3/20/2018
0.7.1 1,353 3/20/2018
0.7.0 1,352 3/16/2018
0.6.1 1,337 3/11/2018
0.6.0 1,341 3/7/2018
0.6.0-beta001 1,096 3/6/2018
0.5.2 1,365 3/1/2018
0.5.2-beta001 1,091 2/25/2018
0.5.1 1,343 2/25/2018
0.5.1-beta001 1,099 2/25/2018
0.5.0 1,414 2/15/2018
0.5.0-beta004 1,086 2/12/2018
0.5.0-beta003 1,103 2/12/2018
0.5.0-beta002 1,109 2/12/2018
0.5.0-beta001 1,087 2/10/2018
0.4.1 1,394 2/10/2018
0.4.1-beta003 1,113 2/10/2018
0.4.1-beta002 1,359 2/9/2018
0.4.1-beta001 1,122 2/9/2018
0.4.0 1,377 1/13/2018
0.3.5 1,674 7/18/2017
0.3.4 1,269 7/3/2017
0.3.3 1,297 6/26/2017
0.3.2 1,313 5/7/2017
0.3.2-alpha001 1,047 5/2/2017
0.3.1 1,239 4/30/2017
0.3.0 1,244 4/30/2017
0.3.0-alpha001 984 4/30/2017
0.2.0 1,350 4/18/2017
0.2.0-alpha001 993 4/18/2017
0.1.0 1,285 4/14/2017
0.1.0-alpha008 978 4/14/2017
0.1.0-alpha007 963 4/14/2017
0.1.0-alpha006 960 4/14/2017
0.1.0-alpha005 1,010 4/14/2017
0.1.0-alpha004 982 4/14/2017
0.1.0-alpha003 997 4/14/2017
0.1.0-alpha002 1,019 4/14/2017
0.1.0-alpha001 1,018 4/14/2017

## [0.29.0-beta001] - 2021-09-29

[0.29.0-beta001]: https://github.com/TheAngryByrd/MiniScaffold/compare/0.28.0...0.29.0-beta001

### Changed
- [Move off fake-cli to build.fsproj](https://github.com/TheAngryByrd/MiniScaffold/pull/246)