@@ -10,7 +10,7 @@ to create a single package.
1010
1111```
1212// Load the recipe
13- #load nuget:?package=NUnit.Cake.Recipe&version=1.0 .0 // Note 1
13+ #load nuget:?package=NUnit.Cake.Recipe&version=1.4 .0 // Note 1
1414
1515// Initialize Build Settings
1616BuildSettings.Initialize( // Note 2
@@ -34,11 +34,11 @@ Build.Run(); // Note 4
3434** NOTES:**
3535
36361 . The ` #load ` statement loads ` NUnit.Cake.Recipe ` , specifying the version to use,
37- in this case version 1.0 .0. It is recommended that you specify the recipe
37+ in this case version 1.4 .0. You should always specify the recipe
3838 version to avoid unpleasant surprises when the recipe is updated.
3939
40402 . ` BuildSettings.Initialize ` sets the parameters which drive the build process. The example
41- specifies only the three required paraameters .
41+ specifies only the three required arguments .
4242
43433 . Define a single ` nuget ` package.
4444
@@ -49,19 +49,15 @@ Build.Run(); // Note 4
4949The recipe supports a number of standard command-line arguments. Additional arguments may be
5050supported directly by the user's ` build.cake ` file, but must not conflict with the built-in arguments.
5151
52- Arguments taking a value may use ` = ` or space to separate the name from the value and
53- may be specified in abbreviated form, down to the minimum length shown in square braces.
54- Single character abbreviations use a single dash.
55-
56- #### --target=TARGET [ -t]
52+ #### --target, -t=TARGET
5753The name of the TARGET task to be run, e.g. Test. Default is "Build." For a list
5854of supported targets, use the Cake ` --description ` option.
5955
60- #### --configuration=CONFIG [ -c ]
56+ #### --configuration, -c=CONFIG
6157The name of the configuration to build, test and/or package, e.g. Debug.
6258Defaults to Release.
6359
64- #### --packageVersion=VERSION [ --pack ]
60+ #### --packageVersion=VERSION
6561Specifies the full package version, including any pre-release
6662suffix. This version is used directly instead of the default
6763version from the script or that calculated by GitVersion.
@@ -70,17 +66,16 @@ derived from the package version.
7066
7167NOTE: We can't use "version" since that's an argument to Cake itself.
7268
73- #### --where=SELECTION [ -w]
74- Specifies a selction expression used to choose which packages
75- to build and test, for use in debugging. Consists of one or
76- more specifications, separated by '|' and '&'. Each specification
77- is of the form "prop=value", where prop may be either id or type.
78- Examples:
79- * --where type=nuget
80- * --where id=NUnit.Engine.Api
81- * --where "type=nuget|type=choco"
82-
83- #### --level=LEVEL [ --lev]
69+ #### --packageId, --id=ID
70+ Specifies the id of a package for which packaging is to be performed.
71+ If not specified, all ids are processed.
72+
73+ #### --packageType, --type=TYPE
74+ Specifies the type package for which packaging is to be performed.
75+ Valid values for TYPE are 'nuget', 'choco' and 'zip'.
76+ If not specified, all types are processed.
77+
78+ #### --level, --lev=LEVEL
8479Specifies the level of package testing, which is normally set
8580automatically for different types of builds like CI, PR, etc.
8681Used by developers to test packages locally without creating
@@ -89,17 +84,17 @@ a PR or publishing the package. Defined levels are
8984 2 . Adds more tests for PRs and Dev builds uploaded to MyGet
9085 3 . Adds even more tests prior to publishing a release
9186
92- #### --trace=LEVEL [ --tr]
87+ #### --trace, --tr=LEVEL
9388Specifies the default trace level for this run. Values are Off,
9489Error, Warning, Info or Debug. Default is Off.
9590
96- #### --nobuild [ --nob]
91+ #### --nobuild, --nob
9792Indicates that the Build task should not be run even if other
9893tasks depend on it. The existing build is used instead.
9994
100- #### --nopush [ --nop]
95+ #### --nopush, --nop
10196Indicates that no publishing or releasing should be done. If
10297publish or release targets are run, a message is displayed.
10398
104- #### --usage [ --us ]
99+ #### --usage
105100Displays a general help message. No targets are run.
0 commit comments