You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/configuration/publish.md
+88-29
Original file line number
Diff line number
Diff line change
@@ -12,23 +12,23 @@ If `KEYGEN_TOKEN` is defined and `GH_TOKEN` or `GITHUB_TOKEN` is not — default
12
12
!!! info "Snap store"
13
13
`snap` target by default publishes to snap store (the app store for Linux). To force publishing to another providers, explicitly specify publish configuration for `snap`.
14
14
15
-
You can publish to multiple providers. For example, to publish Windows artifacts to both GitHub and Bintray (order is important — first item will be used as a default auto-update server, so, in this example app will use github as auto-update provider):
15
+
You can publish to multiple providers. For example, to publish Windows artifacts to both GitHub and Bitbucket (order is important — first item will be used as a default auto-update server, so, in this example app will use github as auto-update provider):
16
16
17
-
```json tab="package.json"
17
+
```json
18
18
{
19
19
"build": {
20
20
"win": {
21
-
"publish": ["github", "bintray"]
21
+
"publish": ["github", "bitbucket"]
22
22
}
23
23
}
24
24
}
25
25
```
26
26
27
-
```yaml tab="electron-builder.yaml"
27
+
```yaml
28
28
win:
29
29
publish:
30
30
- github
31
-
- bintray
31
+
- bitbucket
32
32
```
33
33
34
34
You can also configure publishing using CLI arguments, for example, to force publishing snap not to Snap Store, but to GitHub: `-c.snap.publish=github`
@@ -66,7 +66,7 @@ But please consider using automatic rules instead of explicitly specifying `publ
66
66
67
67
Add to `scripts` in the development `package.json`:
68
68
69
-
```json tab="package.json"
69
+
```json
70
70
"release": "electron-builder"
71
71
```
72
72
@@ -92,7 +92,7 @@ This example workflow is modelled on how releases are handled in maven (it is an
92
92
3. When you are ready to deploy, simply change you package version to `1.9.0` and push. This will then produce a `latest.yml` and `something.exe` on s3. Usually you'll git-tag this version as well (just to keep track of it).
93
93
4. Change the version back to a snapshot version right after, i.e. `1.10.0-snapshot`, and commit it.
<p><code id="KeygenOptions-requestHeaders">requestHeaders</code> module:http.OutgoingHttpHeaders - Any custom request headers</p>
217
227
</li>
218
228
</ul>
219
-
220
-
<!-- end of generated block -->
221
-
222
-
## S3Options
223
-
[Amazon S3](https://aws.amazon.com/s3/) options.
224
-
225
-
AWS credentials are required, please see [getting your credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html).
226
-
Define `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` [environment variables](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-environment.html).
227
-
Or in the [~/.aws/credentials](http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html).
<li><code id="BitbucketOptions-channel">channel</code> = <code>latest</code> String | “undefined” - The channel.</li>
244
+
</ul>
245
+
<p>Inherited from <code>PublishConfiguration</code>:</p>
246
+
<ul>
247
+
<li>
248
+
<p><code id="BitbucketOptions-publishAutoUpdate">publishAutoUpdate</code> = <code>true</code> Boolean - Whether to publish auto update info files.</p>
249
+
<p>Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.</p>
250
+
</li>
251
+
<li>
252
+
<p><code id="BitbucketOptions-requestHeaders">requestHeaders</code> module:http.OutgoingHttpHeaders - Any custom request headers</p>
AWS credentials are required, please see <a href="http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html">getting your credentials</a>.
258
+
Define <code>AWS_ACCESS_KEY_ID</code> and <code>AWS_SECRET_ACCESS_KEY</code> <a href="http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-environment.html">environment variables</a>.
259
+
Or in the <a href="http://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html">~/.aws/credentials</a>.</p>
<p><strong><code id="S3Options-provider">provider</code></strong> “s3” - The provider. Must be <code>s3</code>.</p>
273
+
</li>
274
+
<li>
275
+
<p><strong><code id="S3Options-bucket">bucket</code></strong> String - The bucket name.</p>
276
+
</li>
277
+
<li>
278
+
<p><code id="S3Options-region">region</code> String | “undefined” - The region. Is determined and set automatically when publishing.</p>
279
+
</li>
280
+
<li>
281
+
<p><code id="S3Options-acl">acl</code> = <code>public-read</code> “private” | “public-read” | “undefined” - The ACL. Set to <code>null</code> to not <a href="https://github.com/electron-userland/electron-builder/issues/1822">add</a>.</p>
282
+
<p>Please see <a href="https://github.com/electron-userland/electron-builder/issues/1618#issuecomment-314679128">required permissions for the S3 provider</a>.</p>
283
+
</li>
284
+
<li>
285
+
<p><code id="S3Options-storageClass">storageClass</code> = <code>STANDARD</code> “STANDARD” | “REDUCED_REDUNDANCY” | “STANDARD_IA” | “undefined” - The type of storage to use for the object.</p>
286
+
</li>
287
+
<li>
288
+
<p><code id="S3Options-encryption">encryption</code> “AES256” | “aws:kms” | “undefined” - Server-side encryption algorithm to use for the object.</p>
289
+
</li>
290
+
<li>
291
+
<p><code id="S3Options-endpoint">endpoint</code> String | “undefined” - The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like <code>https://{service}.{region}.amazonaws.com</code>.</p>
<li><codeid="DebOptions-depends">depends</code> Array<String> | “undefined” - Package dependencies. Defaults to <code>["gconf2", "gconf-service", "libnotify4", "libappindicator1", "libxtst6", "libnss3"]</code>. If need to support Debian, <code>libappindicator1</code> should be removed, <ahref="https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=895037">deprecated in Debian</a>. If need to support KDE, <code>gconf2</code> and <code>gconf-service</code> should be removed, <ahref="https://packages.debian.org/bullseye/gconf2">for GNOME and no longer used by GNOME</a>.</li>
2
+
<li><codeid="DebOptions-depends">depends</code> Array<String> | “undefined” - Package dependencies. Defaults to <code>["gconf2", "gconf-service", "libnotify4", "libappindicator1", "libxtst6", "libnss3"]</code>. If need to support Debian, <code>libappindicator1</code> should be removed, it is <ahref="https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=895037">deprecated in Debian</a>. If need to support KDE, <code>gconf2</code> and <code>gconf-service</code> should be removed as it’s no longer used by GNOME](<ahref="https://packages.debian.org/bullseye/gconf2">https://packages.debian.org/bullseye/gconf2</a>).</li>
3
3
<li><codeid="DebOptions-packageCategory">packageCategory</code> String | “undefined” - The <ahref="https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section">package category</a>.</li>
4
4
<li><codeid="DebOptions-priority">priority</code> String | “undefined” - The <ahref="https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority">Priority</a> attribute.</li>
<li><codeid="BitbucketOptions-channel">channel</code> = <code>latest</code> String | “undefined” - The channel.</li>
6
+
</ul>
7
+
<p>Inherited from <code>PublishConfiguration</code>:</p>
8
+
<ul>
9
+
<li>
10
+
<p><codeid="BitbucketOptions-publishAutoUpdate">publishAutoUpdate</code> = <code>true</code> Boolean - Whether to publish auto update info files.</p>
11
+
<p>Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.</p>
12
+
</li>
13
+
<li>
14
+
<p><codeid="BitbucketOptions-requestHeaders">requestHeaders</code> module:http.OutgoingHttpHeaders - Any custom request headers</p>
0 commit comments