AppCenterCodepushReleaseElectronSettings Class

Summary

Settings for appcenter codepush release-electron. Release an Electron update to a deployment.
Assembly
Cake.AppCenter.dll
Namespace
Cake.AppCenter
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.AppCenter/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["AppCenterCodepushReleaseElectronSettings"] class Type type-node

Syntax

public sealed class AppCenterCodepushReleaseElectronSettings : AutoToolSettings

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Properties

Name Value Summary
App string
-a|--app <arg> Specify app in the <ownerName>/<appName> format
BundleName string
-b|--bundle-name <arg> Name of the generated JS bundle file. If unspecified, the standard bundle name will be used 'index.electron.bundle'
Config string
-c|--config <arg> Path to the webpack config file. If omitted, "webpack.config.js" will be used (if they exist)
Debug Nullable<bool>
--debug Display extra output for debugging
DeploymentName string
-d|--deployment-name <arg> Deployment to release the update to
Description string
--description <arg> Description of the changes made to the app in this release
Development Nullable<bool>
--development Specifies whether to generate a Development or Production build
Disabled Nullable<bool>
-x|--disabled Specifies whether this release should be immediately downloadable
DisableDuplicateReleaseError Nullable<bool>
--disable-duplicate-release-error When this flag is set, releasing a package that is identical to the latest release will produce a warning instead of an error
DisableTelemetry Nullable<bool>
--disable-telemetry Disable telemetry for this command
EntryFile string
-e|--entry-file <arg> Path to the app's entry JavaScript file. If omitted, "index.<platform>.js" and then "index.js" will be used (if they exist)
Env string
--env <arg> Environment when using API token
ExtraBundlerOption string
--extra-bundler-option <arg> Option that gets passed to webpack bundler. Can be specified multiple times
Help Nullable<bool>
-h|--help Display help for current command
Mandatory Nullable<bool>
-m|--mandatory Specifies whether this release should be considered mandatory
Output string
--output <arg> Output format: json
OutputDir string
-o|--output-dir <arg> Output path for the bundle and sourcemap. If omitted, a bundle and sourcemap will not be generated
PrivateKeyPath string
-k|--private-key-path <arg> Specifies the location of a RSA private key to sign the release with.NOTICE: use it for react native applications only, client SDK on other platforms will be ignoring signature verification for now!
Quiet Nullable<bool>
--quiet Auto-confirm any prompts without waiting for input
Rollout string
-r|--rollout <arg> Percentage of users this release should be available to
SourcemapOutput string
-s|--sourcemap-output <arg> Filename (including path) for the sourcemap of the resulting bundle. If 'sourcemap-output' and 'sourcemap-output-dir' are omitted, a sourcemap will not be generated
SourcemapOutputDir string
--sourcemap-output-dir <arg> Path to directory where the sourcemap for the resulting bundle should be written. Name of sourcemap file will be generated automatically. This argument will be ignored if 'sourcemap-output' argument is provided. If 'sourcemap-output' and 'sourcemap-output-dir' are omitted, a sourcemap will not be generated
TargetBinaryVersion string
-t|--target-binary-version <arg> Semver expression that specifies the binary app version(s) this release is targeting (e.g. 1.1.0, ~1.2.3)
Token string
--token <arg> API token
Version Nullable<bool>
-v|--version Display appcenter version

Extension Methods

Name Value Summary
Dump<AppCenterCodepushReleaseElectronSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AppCenterCodepushReleaseElectronSettings>(AppCenterCodepushReleaseElectronSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AppCenterCodepushReleaseElectronSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AppCenterCodepushReleaseElectronSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AppCenterCodepushReleaseElectronSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AppCenterCodepushReleaseElectronSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin