MiniScaffold 0.31.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.31.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 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.38.0 133 12/7/2024
0.38.0-beta001 83 12/7/2024
0.37.1 3,589 11/19/2023
0.37.0 861 10/25/2023
0.36.2 297 10/22/2023
0.36.1 226 10/21/2023
0.36.0 735 10/6/2023
0.35.2 268 9/18/2023
0.35.0 203 9/18/2023
0.34.2 250 9/14/2023
0.34.1 197 9/5/2023
0.34.0 407 6/9/2023
0.33.0 163 6/7/2023
0.33.0-alpha009 195 6/7/2023
0.33.0-alpha008 169 6/7/2023
0.33.0-alpha007 198 6/7/2023
0.33.0-alpha006 213 6/7/2023
0.33.0-alpha005 204 6/7/2023
0.33.0-alpha004 167 6/7/2023
0.32.0 983 9/17/2022
0.32.0-beta001 252 9/17/2022
0.31.1 667 4/29/2022
0.31.1-beta001 250 4/29/2022
0.31.0 575 2/6/2022
0.31.0-beta001 282 2/6/2022
0.30.0 522 1/18/2022
0.30.0-beta001 209 1/18/2022
0.29.1 505 10/11/2021
0.29.1-beta001 245 10/11/2021
0.29.0 420 9/29/2021
0.29.0-beta001 227 9/29/2021
0.28.0 2,484 6/3/2021
0.27.0 422 5/28/2021
0.27.0-beta002 257 5/28/2021
0.27.0-beta001 221 5/28/2021
0.26.4 436 5/25/2021
0.26.4-beta001 264 5/25/2021
0.26.3 593 3/14/2021
0.26.3-beta001 315 3/14/2021
0.26.2 576 1/22/2021
0.26.1 486 1/19/2021
0.26.1-beta001 279 1/19/2021
0.26.0 498 1/5/2021
0.26.0-beta001 260 1/5/2021
0.25.1 577 11/11/2020
0.25.0 817 7/25/2020
0.25.0-beta001 376 7/25/2020
0.24.4 674 5/9/2020
0.24.3 630 5/9/2020
0.24.2 636 5/1/2020
0.24.1 584 4/23/2020
0.24.0 612 3/26/2020
0.23.5 602 3/24/2020
0.23.4 608 3/8/2020
0.23.3 644 2/24/2020
0.23.2 579 2/24/2020
0.23.1 590 2/24/2020
0.23.0 624 2/13/2020
0.23.0-beta001 428 2/7/2020
0.22.4 725 1/23/2020
0.22.3 634 1/15/2020
0.22.2 645 1/3/2020
0.22.1 662 12/26/2019
0.22.0 675 12/26/2019
0.22.0-beta001 474 12/26/2019
0.21.5 641 12/24/2019
0.21.4-beta001 456 12/24/2019
0.21.3 639 12/21/2019
0.21.2 646 12/21/2019
0.21.1 645 12/16/2019
0.21.0 624 12/13/2019
0.20.2 653 12/13/2019
0.20.1 640 11/26/2019
0.20.0 642 10/22/2019
0.19.2 621 10/22/2019
0.19.1 622 10/21/2019
0.19.0 648 9/24/2019
0.18.0 638 9/20/2019
0.17.1 866 6/4/2019
0.16.4 751 5/20/2019
0.16.3 691 5/17/2019
0.16.2 691 5/17/2019
0.16.1 675 5/9/2019
0.16.0 722 5/8/2019
0.15.1 822 5/3/2019
0.15.0 794 5/2/2019
0.14.2 762 5/2/2019
0.14.2-beta002 573 5/2/2019
0.14.2-beta001 579 5/2/2019
0.14.1 776 4/9/2019
0.14.0 930 2/19/2019
0.14.0-beta001 591 2/18/2019
0.13.0 940 1/9/2019
0.12.1 802 1/9/2019
0.12.0 1,143 9/11/2018
0.11.0 894 8/30/2018
0.11.0-beta002 647 8/30/2018
0.11.0-beta001 654 8/30/2018
0.10.0 974 8/18/2018
0.9.7 959 8/18/2018
0.9.6 936 8/10/2018
0.9.5 1,171 7/9/2018
0.9.4 1,197 6/22/2018
0.9.3 1,274 6/1/2018
0.9.2 1,193 6/1/2018
0.9.1 1,275 5/15/2018
0.9.0 1,230 5/14/2018
0.8.1 1,268 4/9/2018
0.8.0 1,316 3/20/2018
0.8.0-alpha002 952 3/20/2018
0.8.0-alpha001 1,011 3/20/2018
0.7.1 1,242 3/20/2018
0.7.0 1,241 3/16/2018
0.6.1 1,224 3/11/2018
0.6.0 1,227 3/7/2018
0.6.0-beta001 985 3/6/2018
0.5.2 1,246 3/1/2018
0.5.2-beta001 981 2/25/2018
0.5.1 1,223 2/25/2018
0.5.1-beta001 973 2/25/2018
0.5.0 1,304 2/15/2018
0.5.0-beta004 976 2/12/2018
0.5.0-beta003 992 2/12/2018
0.5.0-beta002 999 2/12/2018
0.5.0-beta001 977 2/10/2018
0.4.1 1,282 2/10/2018
0.4.1-beta003 1,003 2/10/2018
0.4.1-beta002 1,248 2/9/2018
0.4.1-beta001 1,006 2/9/2018
0.4.0 1,266 1/13/2018
0.3.5 1,594 7/18/2017
0.3.4 1,191 7/3/2017
0.3.3 1,214 6/26/2017
0.3.2 1,234 5/7/2017
0.3.2-alpha001 970 5/2/2017
0.3.1 1,163 4/30/2017
0.3.0 1,171 4/30/2017
0.3.0-alpha001 904 4/30/2017
0.2.0 1,269 4/18/2017
0.2.0-alpha001 912 4/18/2017
0.1.0 1,208 4/14/2017
0.1.0-alpha008 904 4/14/2017
0.1.0-alpha007 886 4/14/2017
0.1.0-alpha006 885 4/14/2017
0.1.0-alpha005 934 4/14/2017
0.1.0-alpha004 905 4/14/2017
0.1.0-alpha003 916 4/14/2017
0.1.0-alpha002 938 4/14/2017
0.1.0-alpha001 943 4/14/2017

## [0.31.0-beta001] - 2022-02-06

[0.31.0-beta001]: https://github.com/TheAngryByrd/MiniScaffold/compare/0.30.0...0.31.0-beta001

### Changed
- [Update Fantomas to 4.6.1](https://github.com/TheAngryByrd/MiniScaffold/pull/254)