This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.AppCenter.
Summary
Settings for appcenter codepush release-electron.
Release an Electron update to a deployment.
- Assembly
- Cake
.AppCenter .dll - Namespace
- Cake
.AppCenter - Base Types
-
- ToolSettings
- AutoToolSettings
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 |
---|---|
Nullable |
|
NullableAttribute | |
Compiler |
Constructors
Name | Summary |
---|---|
App |
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 |
--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 |
--development
Specifies whether to generate a Development or Production build
|
Disabled | Nullable |
-x|--disabled
Specifies whether this release should be immediately downloadable
|
Disable |
Nullable |
--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 |
--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 |
-h|--help
Display help for current command
|
Mandatory | Nullable |
-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 |
--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 |
-v|--version
Display appcenter version
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|