-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add Google Cloud Storage publisher docs (#9)
Co-authored-by: George Xu <[email protected]>
1 parent
b0d2417
commit a2d931a
Showing
2 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Google Cloud Storage | ||
|
||
{% hint style="info" %} | ||
This publish target was added in Electron Forge 7.1.0. | ||
{% endhint %} | ||
|
||
The Google Cloud Storage (GCS) target publishes all your artifacts to a [Google Cloud Storage bucket](https://cloud.google.com/storage/docs), nothing fancy here, literally just puts all your artifacts straight into the bucket. | ||
|
||
{% hint style="warning" %} | ||
If you run publish twice with the same version on the same platform it is possible for your old artifacts to get overwritten in Storage. It is your responsibility to ensure that you don't overwrite your own releases. | ||
{% endhint %} | ||
|
||
By default all files are positioned at the following key: | ||
|
||
`${config.folder || version}/${artifactName}` | ||
|
||
Configuration options are documented in [`PublisherGCSConfig`](https://js.electronforge.io/publisher/gcs/interfaces/publishergcsconfig.html) | ||
|
||
### Usage | ||
|
||
```javascript | ||
{ | ||
name: '@electron-forge/publisher-gcs', | ||
config: { | ||
bucket: 'my-bucket', | ||
public: true | ||
} | ||
} | ||
``` | ||
|
||
It is recommended to authenticate by providing path to JSON file that contains your Google service account credentials by environment variable `GOOGLE_APPLICATION_CREDENTIALS`. |