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 183 12/7/2024
0.38.0-beta001 107 12/7/2024
0.37.1 3,614 11/19/2023
0.37.0 889 10/25/2023
0.36.2 314 10/22/2023
0.36.1 254 10/21/2023
0.36.0 756 10/6/2023
0.35.2 296 9/18/2023
0.35.0 234 9/18/2023
0.34.2 278 9/14/2023
0.34.1 225 9/5/2023
0.34.0 447 6/9/2023
0.33.0 194 6/7/2023
0.33.0-alpha009 227 6/7/2023
0.33.0-alpha008 199 6/7/2023
0.33.0-alpha007 230 6/7/2023
0.33.0-alpha006 245 6/7/2023
0.33.0-alpha005 239 6/7/2023
0.33.0-alpha004 197 6/7/2023
0.32.0 1,018 9/17/2022
0.32.0-beta001 291 9/17/2022
0.31.1 719 4/29/2022
0.31.1-beta001 305 4/29/2022
0.31.0 619 2/6/2022
0.31.0-beta001 339 2/6/2022
0.30.0 568 1/18/2022
0.30.0-beta001 251 1/18/2022
0.29.1 561 10/11/2021
0.29.1-beta001 292 10/11/2021
0.29.0 473 9/29/2021
0.29.0-beta001 278 9/29/2021
0.28.0 2,536 6/3/2021
0.27.0 479 5/28/2021
0.27.0-beta002 310 5/28/2021
0.27.0-beta001 275 5/28/2021
0.26.4 491 5/25/2021
0.26.4-beta001 311 5/25/2021
0.26.3 641 3/14/2021
0.26.3-beta001 365 3/14/2021
0.26.2 634 1/22/2021
0.26.1 535 1/19/2021
0.26.1-beta001 335 1/19/2021
0.26.0 546 1/5/2021
0.26.0-beta001 318 1/5/2021
0.25.1 635 11/11/2020
0.25.0 877 7/25/2020
0.25.0-beta001 432 7/25/2020
0.24.4 732 5/9/2020
0.24.3 693 5/9/2020
0.24.2 690 5/1/2020
0.24.1 641 4/23/2020
0.24.0 669 3/26/2020
0.23.5 658 3/24/2020
0.23.4 666 3/8/2020
0.23.3 712 2/24/2020
0.23.2 634 2/24/2020
0.23.1 647 2/24/2020
0.23.0 691 2/13/2020
0.23.0-beta001 488 2/7/2020
0.22.4 787 1/23/2020
0.22.3 690 1/15/2020
0.22.2 715 1/3/2020
0.22.1 719 12/26/2019
0.22.0 739 12/26/2019
0.22.0-beta001 542 12/26/2019
0.21.5 699 12/24/2019
0.21.4-beta001 511 12/24/2019
0.21.3 692 12/21/2019
0.21.2 707 12/21/2019
0.21.1 707 12/16/2019
0.21.0 684 12/13/2019
0.20.2 715 12/13/2019
0.20.1 698 11/26/2019
0.20.0 710 10/22/2019
0.19.2 683 10/22/2019
0.19.1 685 10/21/2019
0.19.0 714 9/24/2019
0.18.0 694 9/20/2019
0.17.1 927 6/4/2019
0.16.4 813 5/20/2019
0.16.3 753 5/17/2019
0.16.2 749 5/17/2019
0.16.1 742 5/9/2019
0.16.0 794 5/8/2019
0.15.1 884 5/3/2019
0.15.0 860 5/2/2019
0.14.2 825 5/2/2019
0.14.2-beta002 637 5/2/2019
0.14.2-beta001 641 5/2/2019
0.14.1 841 4/9/2019
0.14.0 994 2/19/2019
0.14.0-beta001 654 2/18/2019
0.13.0 997 1/9/2019
0.12.1 872 1/9/2019
0.12.0 1,208 9/11/2018
0.11.0 976 8/30/2018
0.11.0-beta002 717 8/30/2018
0.11.0-beta001 720 8/30/2018
0.10.0 1,052 8/18/2018
0.9.7 1,040 8/18/2018
0.9.6 1,002 8/10/2018
0.9.5 1,350 7/9/2018
0.9.4 1,366 6/22/2018
0.9.3 1,444 6/1/2018
0.9.2 1,363 6/1/2018
0.9.1 1,446 5/15/2018
0.9.0 1,399 5/14/2018
0.8.1 1,437 4/9/2018
0.8.0 1,490 3/20/2018
0.8.0-alpha002 1,121 3/20/2018
0.8.0-alpha001 1,180 3/20/2018
0.7.1 1,412 3/20/2018
0.7.0 1,411 3/16/2018
0.6.1 1,395 3/11/2018
0.6.0 1,401 3/7/2018
0.6.0-beta001 1,158 3/6/2018
0.5.2 1,429 3/1/2018
0.5.2-beta001 1,153 2/25/2018
0.5.1 1,408 2/25/2018
0.5.1-beta001 1,160 2/25/2018
0.5.0 1,476 2/15/2018
0.5.0-beta004 1,144 2/12/2018
0.5.0-beta003 1,162 2/12/2018
0.5.0-beta002 1,171 2/12/2018
0.5.0-beta001 1,145 2/10/2018
0.4.1 1,458 2/10/2018
0.4.1-beta003 1,169 2/10/2018
0.4.1-beta002 1,422 2/9/2018
0.4.1-beta001 1,185 2/9/2018
0.4.0 1,436 1/13/2018
0.3.5 1,718 7/18/2017
0.3.4 1,313 7/3/2017
0.3.3 1,336 6/26/2017
0.3.2 1,353 5/7/2017
0.3.2-alpha001 1,089 5/2/2017
0.3.1 1,282 4/30/2017
0.3.0 1,287 4/30/2017
0.3.0-alpha001 1,029 4/30/2017
0.2.0 1,394 4/18/2017
0.2.0-alpha001 1,033 4/18/2017
0.1.0 1,329 4/14/2017
0.1.0-alpha008 1,017 4/14/2017
0.1.0-alpha007 1,006 4/14/2017
0.1.0-alpha006 1,001 4/14/2017
0.1.0-alpha005 1,052 4/14/2017
0.1.0-alpha004 1,025 4/14/2017
0.1.0-alpha003 1,037 4/14/2017
0.1.0-alpha002 1,060 4/14/2017
0.1.0-alpha001 1,058 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)