NineTail Labs - CakeScripts

This is a collection of base scripts for Cake that is used by NineTail Labs to build our dotnet projects.
The original goal of the project was simply to provide a set of Cake build scripts that could be shared between projects, however this has grown into a fully-automated project creation tool capable of creating a NetStandard2.0 project and auto-setup GitHub, AppVeyor and Coveralls for the project.

Requirements

The following applications need to be installed and accessible on the Path:

• Git
• DotNet Core

QuickStart

To quickly create and set up a new Git repository grab the QuickStart PowerShell script with the following

Invoke-WebRequest https://raw.githubusercontent.com/NinetailLabs/CakeScripts/master/quickstart.ps1 -OutFile quickstart.ps1

Then invoke the script

.\quickstart.ps1 -repo <repo-name>

The QuickStart script does the following

• Create a new Git repository
• Pull down the build.ps1 bootstrap file
• Add the VisualStudio .gitignore file from GitHub
• Add the CakeScript repository as a Git submodule
• Copy the template.build.cake to the repository root and rename it to build.cake

NetStandard2.0 Project QuickStart

The Quickstart also support the creation of a pre-configured NetStandard2.0 project.
Invoke the quickstart script as follows

.\quickstart.ps1 -repo <repo-name> -initProject $true

Beside the basic Quickstart configuration, a Visual Studio solutions will be created with the following:

• Solution file named the same as the repo value passed
• NetStandard2.0 class library with:
  • SemVer.Git.MSBuild for automated SemVer versioning
  • Microsoft.SourceLink.GitHub for GitHub based SourceLink
  • Nuspec template
  • SemVer.MSBuild.props pre-configured to create version numbers starting with 1.0.0
• NetCore2.1 XUnit test project with:
  • FluentAssertions
  • Moq
• Git tag 1.0.0.0 that is used by SemVer.Git.MSBuild for versioning start point
• NineTailLabs.DotSettings that contains the ReSharper settings used by NineTail Labs for code layout (Currently this has to be hooked into ReSharper manually)

Repository auto-creation

The quickstart script can be used to automatically set up a GitHub repository, AppVeyor build for the repository as well as a Coveralls code coverage project for the repository.
In order for auto-creation to work the script requires an access token for each of the services that should be auto-configured. Tokens are retrieved from the Tokens.json file which should be in the same directory as the quickstart.ps1 script.
Note: The first master commit will not push a Nuget package as the first package will simply be an empty shell

A template can be downloaded using:

Invoke-WebRequest https://raw.githubusercontent.com/NinetailLabs/CakeScripts/master/scripts/Tokens.json -OutFile Tokens.json

To run the quickstart with auto-creation invoke it as follows

.\quickstart.ps1 -repoOwner <repo-owner> -repo <repo-name> -repoDescription <repo-description> [-documentBotname <document-bot-name>] -initProject $true -forOrganization <boolean>

Parameters

• repoOwner - The name of the repository owner. In most cases this will be the user's GitHub username unless the repo is being set up for an organization
• repo - The name of the repository to create, this will also be the name of the project that is created
• repoDescription - The description for the project on GitHub
• documentBoName - Name of the Bot account used to publish documentation, if the user is going to use their own account then this should be the same as repoOwner
• initProject - Set to $true to set up the GitHub, AppVeyor and Coveralls projects
• forOrganization - Set to $true if the repository should be created under an organization otherwise it is set up for the user's own account

Tokens can be generated as follows:

Github

Token can be generated here.
The token needs the public_repo claim (currently private repos are not supported by the script)

AppVeyor

Token can be found here

Coveralls

Token can be generated here

Tokens allow access to your account and should be carefully gaurded! It is recommended to store the Tokens.json file in a password safe, that way the tokens are kept secure and can be easily retrieved when needed.

Troubleshooting

If PowerShell has a security issue, read the Cake guide here

Special Thanks

Thanks to Jeffery Hicks who provided the excellent code for creating GitHub repositories from powershell