MiniScaffold 0.33.0-alpha009

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.33.0-alpha009
                    
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.38.0 187 12/7/2024
0.38.0-beta001 109 12/7/2024
0.37.1 3,617 11/19/2023
0.37.0 893 10/25/2023
0.36.2 316 10/22/2023
0.36.1 258 10/21/2023
0.36.0 761 10/6/2023
0.35.2 299 9/18/2023
0.35.0 238 9/18/2023
0.34.2 282 9/14/2023
0.34.1 232 9/5/2023
0.34.0 456 6/9/2023
0.33.0 203 6/7/2023
0.33.0-alpha009 235 6/7/2023
0.33.0-alpha008 207 6/7/2023
0.33.0-alpha007 237 6/7/2023
0.33.0-alpha006 253 6/7/2023
0.33.0-alpha005 246 6/7/2023
0.33.0-alpha004 204 6/7/2023
0.32.0 1,027 9/17/2022
0.32.0-beta001 299 9/17/2022
0.31.1 728 4/29/2022
0.31.1-beta001 314 4/29/2022
0.31.0 626 2/6/2022
0.31.0-beta001 345 2/6/2022
0.30.0 574 1/18/2022
0.30.0-beta001 257 1/18/2022
0.29.1 568 10/11/2021
0.29.1-beta001 299 10/11/2021
0.29.0 479 9/29/2021
0.29.0-beta001 285 9/29/2021
0.28.0 2,543 6/3/2021
0.27.0 485 5/28/2021
0.27.0-beta002 316 5/28/2021
0.27.0-beta001 281 5/28/2021
0.26.4 496 5/25/2021
0.26.4-beta001 317 5/25/2021
0.26.3 647 3/14/2021
0.26.3-beta001 371 3/14/2021
0.26.2 640 1/22/2021
0.26.1 541 1/19/2021
0.26.1-beta001 341 1/19/2021
0.26.0 553 1/5/2021
0.26.0-beta001 330 1/5/2021
0.25.1 642 11/11/2020
0.25.0 885 7/25/2020
0.25.0-beta001 441 7/25/2020
0.24.4 739 5/9/2020
0.24.3 703 5/9/2020
0.24.2 697 5/1/2020
0.24.1 649 4/23/2020
0.24.0 676 3/26/2020
0.23.5 667 3/24/2020
0.23.4 674 3/8/2020
0.23.3 723 2/24/2020
0.23.2 642 2/24/2020
0.23.1 656 2/24/2020
0.23.0 698 2/13/2020
0.23.0-beta001 497 2/7/2020
0.22.4 794 1/23/2020
0.22.3 698 1/15/2020
0.22.2 723 1/3/2020
0.22.1 728 12/26/2019
0.22.0 748 12/26/2019
0.22.0-beta001 549 12/26/2019
0.21.5 706 12/24/2019
0.21.4-beta001 519 12/24/2019
0.21.3 701 12/21/2019
0.21.2 714 12/21/2019
0.21.1 717 12/16/2019
0.21.0 692 12/13/2019
0.20.2 724 12/13/2019
0.20.1 708 11/26/2019
0.20.0 717 10/22/2019
0.19.2 694 10/22/2019
0.19.1 695 10/21/2019
0.19.0 722 9/24/2019
0.18.0 702 9/20/2019
0.17.1 936 6/4/2019
0.16.4 822 5/20/2019
0.16.3 762 5/17/2019
0.16.2 756 5/17/2019
0.16.1 750 5/9/2019
0.16.0 802 5/8/2019
0.15.1 892 5/3/2019
0.15.0 870 5/2/2019
0.14.2 834 5/2/2019
0.14.2-beta002 646 5/2/2019
0.14.2-beta001 649 5/2/2019
0.14.1 848 4/9/2019
0.14.0 1,005 2/19/2019
0.14.0-beta001 662 2/18/2019
0.13.0 1,006 1/9/2019
0.12.1 881 1/9/2019
0.12.0 1,217 9/11/2018
0.11.0 984 8/30/2018
0.11.0-beta002 733 8/30/2018
0.11.0-beta001 728 8/30/2018
0.10.0 1,059 8/18/2018
0.9.7 1,050 8/18/2018
0.9.6 1,012 8/10/2018
0.9.5 1,372 7/9/2018
0.9.4 1,388 6/22/2018
0.9.3 1,468 6/1/2018
0.9.2 1,385 6/1/2018
0.9.1 1,469 5/15/2018
0.9.0 1,420 5/14/2018
0.8.1 1,458 4/9/2018
0.8.0 1,512 3/20/2018
0.8.0-alpha002 1,144 3/20/2018
0.8.0-alpha001 1,203 3/20/2018
0.7.1 1,438 3/20/2018
0.7.0 1,434 3/16/2018
0.6.1 1,418 3/11/2018
0.6.0 1,424 3/7/2018
0.6.0-beta001 1,178 3/6/2018
0.5.2 1,452 3/1/2018
0.5.2-beta001 1,174 2/25/2018
0.5.1 1,430 2/25/2018
0.5.1-beta001 1,182 2/25/2018
0.5.0 1,497 2/15/2018
0.5.0-beta004 1,166 2/12/2018
0.5.0-beta003 1,184 2/12/2018
0.5.0-beta002 1,194 2/12/2018
0.5.0-beta001 1,166 2/10/2018
0.4.1 1,479 2/10/2018
0.4.1-beta003 1,190 2/10/2018
0.4.1-beta002 1,444 2/9/2018
0.4.1-beta001 1,207 2/9/2018
0.4.0 1,459 1/13/2018
0.3.5 1,733 7/18/2017
0.3.4 1,329 7/3/2017
0.3.3 1,352 6/26/2017
0.3.2 1,368 5/7/2017
0.3.2-alpha001 1,103 5/2/2017
0.3.1 1,297 4/30/2017
0.3.0 1,302 4/30/2017
0.3.0-alpha001 1,045 4/30/2017
0.2.0 1,413 4/18/2017
0.2.0-alpha001 1,049 4/18/2017
0.1.0 1,345 4/14/2017
0.1.0-alpha008 1,033 4/14/2017
0.1.0-alpha007 1,021 4/14/2017
0.1.0-alpha006 1,018 4/14/2017
0.1.0-alpha005 1,068 4/14/2017
0.1.0-alpha004 1,040 4/14/2017
0.1.0-alpha003 1,054 4/14/2017
0.1.0-alpha002 1,077 4/14/2017
0.1.0-alpha001 1,074 4/14/2017

## [0.33.0-alpha009] - 2023-06-07

[0.33.0-alpha009]: https://github.com/TheAngryByrd/MiniScaffold//compare/v0.32.0...v0.33.0-alpha009

### Changed
- [Update Dependencies](https://github.com/TheAngryByrd/MiniScaffold/pull/267) from @TheAngryByrd
- [Numerous Build Tweaks](https://github.com/TheAngryByrd/MiniScaffold/pull/269) from @TheAngryByrd
- [Updating Publishing and Use FSDocs for documentation](https://github.com/TheAngryByrd/MiniScaffold/pull/271) from @nikoyak