Summary
Contains settings used by
NpmBumpVersionTool.
- Namespace
- Cake
.Npm .BumpVersion - Base Types
-
- object
- NpmSettings
graph BT
Type-->Base0["NpmSettings"]
click Base0 "/Cake.Npm/api/Cake.Npm/NpmSettings"
Base0-->Base1["object"]
Type["NpmBumpVersionSettings"]
class Type type-node
Syntax
public class NpmBumpVersionSettings : NpmSettingsConstructors
| Name | Summary |
|---|---|
| Npm |
Initializes a new instance of the NpmBumpVersionSettings class.
|
Properties
| Name | Value | Summary |
|---|---|---|
| AllowSameVersion | bool? |
Gets or sets the
--allow-same-version option.
Prevents throwing an error when npm version is used to set the new version to the same value as the current version.
|
| CommitMessage | string |
Gets or sets the commit message.
|
| Force | bool |
Gets or sets the force-option
|
| GitTagVersion | bool? |
Gets or sets the
--git-tag-version option.
Tag the commit when using the npm version command. Setting this to false results in no commit being made at all.
|
| Version | string |
Gets or sets the version to bump to. Should be a valid semver
or one of
"patch", "minor", "major",
"prepatch", "preminor", "premajor",
"prerelease" or "from-git".
|
Methods
| Name | Value | Summary |
|---|---|---|
| EvaluateCore |
void |
Evaluates the settings and writes them to args.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| FromPath |
NpmSettings |
Sets the working directory which should be used to run the npm command.
|
| Set |
NpmSettings |
Sets the StandardError-Action
|
| Set |
NpmSettings |
Sets the StandardOutput-Action
|
| WithCommitMessage |
Npm |
Sets the commit message.
|
| WithForce |
Npm |
Defines that npm version should commit, even if the repository is not clean.
|
| WithLogLevel |
NpmSettings |
Sets the log level which should be used to run the npm command.
|
| WithVersion |
Npm |
Sets the version to bump.
|