Update this readme file with your details.
This project supports a wide variety of commands, all of which can be listed via:
Windows
c:\> build.cmd help
Linux / OS X
c:\> build.sh help
However, please see this readme for full details.
build.[cmd|sh] all
- runs the entire build system minus documentation:NBench
,Tests
, andNuget
.build.[cmd|sh] buildrelease
- compiles the solution inRelease
mode.build.[cmd|sh] tests
- compiles the solution inRelease
mode and runs the unit test suite (all projects that end with the.Tests.csproj
suffix). All of the output will be published to the./TestResults
folder.build.[cmd|sh] nbench
- compiles the solution inRelease
mode and runs the NBench performance test suite (all projects that end with the.Tests.Performance.csproj
suffix). All of the output will be published to the./PerfResults
folder.build.[cmd|sh] nuget
- compiles the solution inRelease
mode and creates Nuget packages from any project that does not have<IsPackable>false</IsPackable>
set and uses the version number fromRELEASE_NOTES.md
.build.[cmd|sh] nuget nugetprerelease=dev
- compiles the solution inRelease
mode and creates Nuget packages from any project that does not have<IsPackable>false</IsPackable>
set - but in this instance all projects will have aVersionSuffix
of-beta{DateTime.UtcNow.Ticks}
. It's typically used for publishing nightly releases.build.[cmd|sh] nuget SignClientUser=$(signingUsername) SignClientSecret=$(signingPassword)
- compiles the solution inRelease
modem creates Nuget packages from any project that does not have<IsPackable>false</IsPackable>
set using the version number fromRELEASE_NOTES.md
, and then signs those packages using the SignClient data below.build.[cmd|sh] nuget SignClientUser=$(signingUsername) SignClientSecret=$(signingPassword) nugetpublishurl=$(nugetUrl) nugetkey=$(nugetKey)
- compiles the solution inRelease
modem creates Nuget packages from any project that does not have<IsPackable>false</IsPackable>
set using the version number fromRELEASE_NOTES.md
, signs those packages using the SignClient data below, and then publishes those packages to the$(nugetUrl)
using NuGet key$(nugetKey)
.build.[cmd|sh] DocFx
- compiles the solution inRelease
mode and then uses DocFx to generate website documentation inside the./docs/_site
folder. Use the./serve-docs.cmd
on Windows to preview the documentation.
This build script is powered by FAKE; please see their API documentation should you need to make any changes to the build.fsx
file.
This project will automatically populate its release notes in all of its modules via the entries written inside RELEASE_NOTES.md
and will automatically update the versions of all assemblies and NuGet packages via the metadata included inside common.props
.
RELEASE_NOTES.md
#### 0.1.0 October 05 2019 ####
First release
In this instance, the NuGet and assembly version will be 0.1.0
based on what's available at the top of the RELEASE_NOTES.md
file.
RELEASE_NOTES.md
#### 0.1.0-beta1 October 05 2019 ####
First release
But in this case the NuGet and assembly version will be 0.1.0-beta1
.
If you add any new projects to the solution created with this template, be sure to add the following line to each one of them in order to ensure that you can take advantage of common.props
for standardization purposes:
<Import Project="..\common.props" />
The attached build script will automatically do the following based on the conventions of the project names added to this project:
- Any project name ending with
.Tests
will automatically be treated as a XUnit2 project and will be included during the test stages of this build script; - Any project name ending with
.Tests.Performance
will automatically be treated as a NBench project and will be included during the test stages of this build script; and - Any project meeting neither of these conventions will be treated as a NuGet packaging target and its
.nupkg
file will automatically be placed in thebin\nuget
folder upon running thebuild.[cmd|sh] all
command.
This solution also supports DocFx for generating both API documentation and articles to describe the behavior, output, and usages of your project.
All of the relevant articles you wish to write should be added to the /docs/articles/
folder and any API documentation you might need will also appear there.
All of the documentation will be statically generated and the output will be placed in the /docs/_site/
folder.
To preview the documentation for this project, execute the following command at the root of this folder:
C:\> serve-docs.cmd
This will use the built-in docfx.console
binary that is installed as part of the NuGet restore process from executing any of the usual build.cmd
or build.sh
steps to preview the fully-rendered documentation. For best results, do this immediately after calling build.cmd buildRelease
.
This project uses SignService to code-sign NuGet packages prior to publication. The build.cmd
and build.sh
scripts will automatically download the SignClient
needed to execute code signing locally on the build agent, but it's still your responsibility to set up the SignService server per the instructions at the linked repository.
Once you've gone through the ropes of setting up a code-signing server, you'll need to set a few configuration options in your project in order to use the SignClient
:
- Add your Active Directory settings to
appsettings.json
and - Pass in your signature information to the
signingName
,signingDescription
, andsigningUrl
values insidebuild.fsx
.
Whenever you're ready to run code-signing on the NuGet packages published by build.fsx
, execute the following command:
C:\> build.cmd nuget SignClientSecret={your secret} SignClientUser={your username}
This will invoke the SignClient
and actually execute code signing against your .nupkg
files prior to NuGet publication.
If one of these two values isn't provided, the code signing stage will skip itself and simply produce unsigned NuGet code packages.