发布者 ¶

publishAutoUpdate?¶

readonly optional publishAutoUpdate: boolean

是否发布自动更新信息文件。

自动更新仅依赖列表中的第一个提供商（您可以指定多个发布者）。因此，可能不需要为其他配置的提供商上传元数据文件。但默认情况下会上传。

默认值¶

true

继承自¶

requestHeaders?¶

readonly optional requestHeaders: OutgoingHttpHeaders

任何自定义请求标头

继承自¶

slug¶

readonly slug: string

仓库 slug/名称

timeout?¶

readonly optional timeout: null | number

请求超时时间，以毫秒为单位。（默认值为 2 分钟；O 将被忽略）

默认值¶

继承自¶

token?¶

readonly optional token: null | string

用于支持从私有 bitbucket 仓库自动更新的应用密码。

username?¶

readonly optional username: null | string

用于支持从私有 bitbucket 仓库自动更新的用户名。

Github¶

Electron-Builder / builder-util-runtime / GithubOptions

GitHub 选项。

需要 GitHub 个人访问令牌。您可以通过访问 https://github.com/settings/tokens/new 来生成。访问令牌应具有 repo 作用域/权限。定义 GH_TOKEN 环境变量。

继承自

PublishConfiguration

属性¶

渠道?¶

readonly optional channel: null | string

渠道。

默认值¶

latest

主机?¶

readonly optional host: null | string

主机（包括需要的端口）。

默认值¶

github.com

所有者?¶

readonly optional owner: null | string

所有者。

私有?¶

readonly optional private: null | boolean

如果定义了 GH_TOKEN 环境变量，是否使用私有 github 自动更新提供商。请参阅私有 GitHub 更新仓库。

协议?¶

readonly optional protocol: null | "https" | "http"

协议。GitHub 发布者仅支持 https。

默认值¶

https

提供者¶

readonly provider: "github"

提供者。必须是 github。

覆盖¶

publishAutoUpdate?¶

readonly optional publishAutoUpdate: boolean

是否发布自动更新信息文件。

自动更新仅依赖列表中的第一个提供商（您可以指定多个发布者）。因此，可能不需要为其他配置的提供商上传元数据文件。但默认情况下会上传。

默认值¶

true

继承自¶

发布类型?¶

optional releaseType: null | "draft" | "prerelease" | "release"

发布类型。默认情况下，将创建 draft 版本。

您也可以使用环境变量设置发布类型。如果 EP_DRAFT 设置为 true，则为 draft；如果 EP_PRE_RELEASE 设置为 true，则为 prerelease。

默认值¶

draft

仓库?¶

readonly optional repo: null | string

仓库名称。自动检测。

requestHeaders?¶

readonly optional requestHeaders: OutgoingHttpHeaders

任何自定义请求标头

继承自¶

timeout?¶

readonly optional timeout: null | number

请求超时时间，以毫秒为单位。（默认值为 2 分钟；O 将被忽略）

默认值¶

继承自¶

令牌?¶

readonly optional token: null | string

用于支持从私有 github 仓库自动更新的访问令牌。永远不要在配置文件中指定它。仅用于 setFeedURL。

vPrefixedTagName?¶

readonly optional vPrefixedTagName: boolean

是否使用以 v 为前缀的标签名称。

默认值¶

true

Keygen¶

Electron-Builder / builder-util-runtime / KeygenOptions

Keygen 选项。https://keygen.sh/ 定义 KEYGEN_TOKEN 环境变量。

继承自

PublishConfiguration

属性¶

账户¶

readonly account: string

Keygen 账户的 UUID

渠道?¶

readonly optional channel: null | "stable" | "rc" | "beta" | "alpha" | "dev"

渠道。

默认值¶

stable

主机?¶

readonly optional host: string

用于自托管实例的 Keygen 主机

默认值¶

"api.keygen.sh"

平台?¶

readonly optional platform: null | string

目标平台。在发布期间以编程方式显式设置。

产品¶

readonly product: string

Keygen 产品的 UUID

提供者¶

readonly provider: "keygen"

提供者。必须是 keygen。

覆盖¶

publishAutoUpdate?¶

readonly optional publishAutoUpdate: boolean

是否发布自动更新信息文件。

自动更新仅依赖列表中的第一个提供商（您可以指定多个发布者）。因此，可能不需要为其他配置的提供商上传元数据文件。但默认情况下会上传。

默认值¶

true

继承自¶

requestHeaders?¶

readonly optional requestHeaders: OutgoingHttpHeaders

任何自定义请求标头

继承自¶

timeout?¶

readonly optional timeout: null | number

请求超时时间，以毫秒为单位。（默认值为 2 分钟；O 将被忽略）

默认值¶

继承自¶

BaseS3Options.channel

S3¶

Electron-Builder / builder-util-runtime / S3Options

Amazon S3 选项。需要 AWS 凭证，请参阅获取您的凭证。定义 AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY 环境变量。或在 ~/.aws/credentials 中。

示例配置

{
 "build":
   "publish": {
     "provider": "s3",
     "bucket": "bucket-name"
   }
 }
}

继承自

BaseS3Options

属性¶

加速?

readonly optional accelerate: boolean

如果设置为 true，这将启用 s3 加速端点。这些端点具有以下特定格式：${bucketname}.s3-accelerate.amazonaws.com

ACL?

readonly optional acl: null | "private" | "public-read"

ACL。设置为 null 以不添加。

请参阅 S3 提供商所需的权限。

默认值¶

public-read

覆盖¶

BaseS3Options.acl

存储桶¶

readonly bucket: string

存储桶名称。

渠道?¶

optional channel: null | string

更新渠道。

默认值¶

latest

继承自¶

加密?

readonly optional encryption: null | "AES256" | "aws:kms"

用于对象的服务器端加密算法。

端点?

readonly optional endpoint: null | string

用于发送请求的端点 URI。默认端点从配置的区域构建。端点应为类似 https://{service}.{region}.amazonaws.com 的字符串。

forcePathStyle?

readonly optional forcePathStyle: boolean

如果为 true，则强制使用路径样式端点，其中存储桶名称是路径的一部分。路径样式访问

路径?

readonly optional path: null | string

目录路径。

默认值¶

继承自¶

BaseS3Options.path

提供者¶

readonly provider: "s3"

提供者。必须是 s3。

覆盖¶

BaseS3Options.provider

publishAutoUpdate?¶

readonly optional publishAutoUpdate: boolean

是否发布自动更新信息文件。

自动更新仅依赖列表中的第一个提供商（您可以指定多个发布者）。因此，可能不需要为其他配置的提供商上传元数据文件。但默认情况下会上传。

默认值¶

true

继承自¶

BaseS3Options.publishAutoUpdate

区域?¶

optional region: null | string

区域。在发布时自动确定和设置。

requestHeaders?¶

readonly optional requestHeaders: OutgoingHttpHeaders

任何自定义请求标头

继承自¶

BaseS3Options.requestHeaders

存储类别?¶

readonly optional storageClass: null | "STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA"

用于对象的存储类型。

默认值¶

STANDARD

timeout?¶

readonly optional timeout: null | number

请求超时时间，以毫秒为单位。（默认值为 2 分钟；O 将被忽略）

默认值¶

继承自¶

BaseS3Options.timeout

Snap Store¶

Electron-Builder / builder-util-runtime / SnapStoreOptions

Snap Store 选项。要直接发布到 Snapcraft，请参阅 Snapcraft 身份验证选项，以获取本地或 CI/CD 身份验证选项。

继承自

PublishConfiguration

属性¶

渠道?

readonly optional channels: null | string | string[]

snap 将发布的渠道列表。

默认值¶

["edge"]

提供者¶

readonly provider: "snapStore"

提供者。必须是 snapStore。

覆盖¶

publishAutoUpdate?

readonly optional publishAutoUpdate: boolean

是否发布自动更新信息文件。

自动更新仅依赖列表中的第一个提供商（您可以指定多个发布者）。因此，可能不需要为其他配置的提供商上传元数据文件。但默认情况下会上传。

默认值¶

true

继承自¶

仓库?

readonly optional repo: string

snapcraft 仓库名称

requestHeaders?

readonly optional requestHeaders: OutgoingHttpHeaders

任何自定义请求标头

继承自¶

timeout?

readonly optional timeout: null | number

请求超时时间，以毫秒为单位。（默认值为 2 分钟；O 将被忽略）

默认值¶

继承自¶

BaseS3Options.channel

Spaces¶

Electron-Builder / builder-util-runtime / SpacesOptions

DigitalOcean Spaces 选项。需要访问密钥，定义 DO_KEY_ID 和 DO_SECRET_KEY 环境变量。

继承自

BaseS3Options

属性¶

ACL?

readonly optional acl: null | "private" | "public-read"

ACL。设置为 null 以不添加。

默认值¶

public-read

继承自¶

BaseS3Options.acl

渠道?

optional channel: null | string

更新渠道。

默认值¶

latest

继承自¶

名称¶

readonly name: string

空间名称。

路径?

readonly optional path: null | string

目录路径。

默认值¶

继承自¶

BaseS3Options.path

提供者¶

readonly provider: "spaces"

提供者。必须是 spaces。

覆盖¶

BaseS3Options.provider

publishAutoUpdate?

readonly optional publishAutoUpdate: boolean

是否发布自动更新信息文件。

自动更新仅依赖列表中的第一个提供商（您可以指定多个发布者）。因此，可能不需要为其他配置的提供商上传元数据文件。但默认情况下会上传。

默认值¶

true

继承自¶

BaseS3Options.publishAutoUpdate

区域¶

readonly region: string

区域（例如 nyc3）。

requestHeaders?

readonly optional requestHeaders: OutgoingHttpHeaders

任何自定义请求标头

继承自¶

BaseS3Options.requestHeaders

timeout?

readonly optional timeout: null | number

请求超时时间，以毫秒为单位。（默认值为 2 分钟；O 将被忽略）

默认值¶

继承自¶

BaseS3Options.timeout

BYO 通用 (自定义)¶

（也许在 PR 中将其提交到上游！）Electron-Builder / builder-util-runtime / GenericServerOptions

通用（任何 HTTP(S) 服务器）选项。在所有发布选项中，都支持文件宏。

继承自

PublishConfiguration

属性¶

渠道?

readonly optional channel: null | string

渠道。

默认值¶

latest

提供者¶

readonly provider: "generic"

提供者。必须是 generic。

覆盖¶

publishAutoUpdate?

readonly optional publishAutoUpdate: boolean

是否发布自动更新信息文件。

自动更新仅依赖列表中的第一个提供商（您可以指定多个发布者）。因此，可能不需要为其他配置的提供商上传元数据文件。但默认情况下会上传。

默认值¶

true

继承自¶

requestHeaders?

readonly optional requestHeaders: OutgoingHttpHeaders

任何自定义请求标头

继承自¶

timeout?

readonly optional timeout: null | number

请求超时时间，以毫秒为单位。（默认值为 2 分钟；O 将被忽略）

默认值¶

继承自¶