Skip to content

Latest commit

 

History

History
142 lines (106 loc) · 9 KB

BUILD.md

File metadata and controls

142 lines (106 loc) · 9 KB
Raw

The Build System

This build system is powered by NUKE; please see their API documentation should you need to make any changes to the Build.cs file.

To install Nuke GlobalTool and SignClient, execute the following command at the root of this folder:

build.cmd

GitHub Actions yml auto-generation

You can define your GitHub workflows in code and Nuke will generate the YAML files for you.

You can update or add to what exist in Build.CI.GitHubActions.cs (AutoGenerate has to be set to true):

[CustomGitHubActions("pr_validation",
    GitHubActionsImage.WindowsLatest,
    GitHubActionsImage.UbuntuLatest,
    AutoGenerate = true,
    OnPushBranches = new[] { "master", "dev" },
    OnPullRequestBranches = new[] { "master", "dev" },
    CacheKeyFiles = new[] { "global.json", "src/**/*.csproj" },
    InvokedTargets = new[] { nameof(Tests) },
    PublishArtifacts = true)
]
[CustomGitHubActions("Windows_release",
    GitHubActionsImage.WindowsLatest,
    AutoGenerate = true,
    OnPushBranches = new[] { "refs/tags/*" },
    InvokedTargets = new[] { nameof(NuGet) },
    ImportSecrets = new[] { "Nuget_Key" },
    PublishArtifacts = true)
]

To generate or update existing workflow yaml file(s), execute any of the commands (e.g. build.cmd compile):

PS C:\Users\user\source\repos\Akka.Serialization.Compressed> .\build.cmd compile
PowerShell Desktop version 5.1.19041.1320
Microsoft (R) .NET Core SDK version 6.0.101
11:42:25 [INF] Creating directory C:\Users\user\source\repos\Akka.Serialization.Compressed\.github\workflows...
11:42:25 [INF] Creating directory C:\Users\user\source\repos\Akka.Serialization.Compressed\.github\workflows...
11:42:28 [WRN] Configuration files for GitHubActions (Windows_release) have changed.
11:42:28 [WRN] Configuration files for GitHubActions (pr_validation) have changed.
Press any key to continue ...

███╗   ██╗██╗   ██╗██╗  ██╗███████╗
████╗  ██║██║   ██║██║ ██╔╝██╔════╝
██╔██╗ ██║██║   ██║█████╔╝ █████╗  
██║╚██╗██║██║   ██║██╔═██╗ ██╔══╝  
██║ ╚████║╚██████╔╝██║  ██╗███████╗
╚═╝  ╚═══╝ ╚═════╝ ╚═╝  ╚═╝╚══════╝
​ 

Supported Build System Commands

This project comes with some ready-made commands, all of which can be listed via:

 build.cmd help

If you desire to add more commands, please see the Fundamentals.

Summary

The ready-made commands you can start working with (both on Windows and Linux), are detailed as follows:

  • build.cmd Install - installs Nuke.GlobalTool and SignClient - which is the default when no command is passed.
  • build.cmd all - runs the following commands: BuildRelease, RunTests, NBench and Nuget.
  • build.cmd compile - compiles the solution in Release mode. The default mode is Release, to compile in Debug mode => --configuration debug
  • build.cmd buildrelease - compiles the solution in Release mode.
  • build.cmd runtests - compiles the solution in Release 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 nbench - compiles the solution in Release 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 nuget - compiles the solution in Release mode and creates Nuget packages from any project that does not have <IsPackable>false</IsPackable> set and uses the version number from RELEASE_NOTES.md.
  • build.cmd nuget --nugetprerelease dev - compiles the solution in Release mode and creates Nuget packages from any project that does not have <IsPackable>false</IsPackable> set - but in this instance all projects will have a VersionSuffix of -beta{DateTime.UtcNow.Ticks}. It's typically used for publishing nightly releases.
  • build.cmd nuget --SignClientUser $(signingUsername) --SignClientSecret $(signingPassword) - compiles the solution in Release modem creates Nuget packages from any project that does not have <IsPackable>false</IsPackable> set using the version number from RELEASE_NOTES.md, and then signs those packages using the SignClient data below.
  • build.cmd nuget --SignClientUser $(signingUsername) --SignClientSecret $(signingPassword) --nugetpublishurl $(nugetUrl) --nugetkey $(nugetKey) - compiles the solution in Release modem creates Nuget packages from any project that does not have <IsPackable>false</IsPackable> set using the version number from RELEASE_NOTES.md, signs those packages using the SignClient data below, and then publishes those packages to the $(nugetUrl) using NuGet key $(nugetKey).
  • build.cmd DocFx - compiles the solution in Release mode and then uses DocFx to generate website documentation inside the ./docs/_site folder. Use the build.cmd servedocs on Windows to preview the documentation.

This build script is powered by NUKE; please see their API documentation should you need to make any changes to the build.cs file.

Release Notes, Version Numbers, Etc

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 Directory.Build.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] / October 05 2019 ####
First release

But in this case the NuGet and assembly version will be 0.1.0.

Conventions

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 the bin\nuget folder upon running the build.cmd all command.

DocFx for Documentation

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.

Previewing Documentation

To preview the documentation for this project, execute the following command at the root of this folder:

build.cmd servedocs

This will use the built-in docfx.console binary that is installed as part of the NuGet restore process from executing the above command to preview the fully-rendered documentation. For best results, do this immediately after calling build.cmd compile.

Code Signing via SignService

This project uses SignService to code-sign NuGet packages prior to publication. The build.cmd 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, and SigningUrl values inside build.cs.

Whenever you're ready to run code-signing on the NuGet packages published by build.cs, execute the following command:

build.cmd signpackages --SignClientSecret {your secret} --SignClientUser {your username}

This will invoke the SignClient and actually execute code signing against your .nupkg files prior to NuGet publication.