Skip to content

Predefined Tasks

CharliePoole edited this page Jan 24, 2023 · 1 revision

TestCentric.Cake.Recipe provides a number of predefined tasks for use. They may be used directly on the command-line or indirectly by use of IsDependentOn in your build.cake file.

The following is a complete list of the tasks defined in the recipe in alphabetical order. If you're just getting started, this may be a bit complicated so focus on the most commonly used tasks, displayed in bold.

Task Description
Build Builds everything. Dependent on NuGetRestore, CheckHeaders and Clean.
BuildChocolateyPackage Builds the Chocolatey package. Not dependent on Build. Use if you need to rerun the package build after changing the cake script but without changing any C# files.
BuildNuGetPackage Builds the NuGet package. Not dependent on Build. Use if you need to rerun the package build after changing the cake script but without changing any C# files.
CheckHeaders Checks that all source files have the correct standard header. No dependencies.
Clean Cleans the output directory for the selected configuration. No dependencies.
CleanAll Cleans the output directory and deletes all object directories. Dependent on Clean and DeleteObjectDirectories.
CreateDraftRelease Creates a draft release on GitHub. No dependencies. May be run directly in certain recovery situations if you know what you are doing.
CreateProductionRelease Performs a full production release on GitHub. May be run directly in certain recovery situations if you know what you are doing.
DeleteObjectDirectories Deletes all object directories. No dependencies.
InstallChocolateyPackage Intalls the Chocolatey package for verification or testing. No dependencies. Installs last package built.
InstallNuGetPackage Installs the NuGet package for verification or testing. No Dependencies. Installs last package build.
NuGetRestore Restores all NuGet packages used. No Dependencies.
Package Builds, verifies and tests all packages. Dependent on Build, PackageChocolatey and PackageNuGet.
PackageChocolatey Builds, verifies and tests the Chocolatey package. No dependencies. If run directly, uses the last build.
PackageNuGet Builds, verifies and tests the NuGet package. No dependencies. If run directly, uses the last build.
Publish Publishes all packages. Dependent on PublishToMyGet, PublishToNuGet and PublishToChocolatey.
PublishToChocolatey Publishes the Chocolatey package to chocolatey.org if needed based on version built.
PublishToMyGet Publishes both the NuGet and Chocolatey packages to myget.org if needed based on version built.
PublishToNuGet Publishes the NuGet package to nuget.org if needed based on version built.
Test Runs the unit tests. Dependent on Build.
TestChocolateyPackage Tests the Chocolatey package. Dependent on InstallChocolateyPackage.
TestNuGetPackage Tests the NuGet package. Dependent on InstallNuGetPackage.
VerifyChocolateyPackage Checks contents of the Chocolatey package. Dependent on InstallChocolateyPackage.
VerifyNuGetPackage Checks contents of the NuGet package. Dependent on InstallNuGetPackage.

Clone this wiki locally