Skip to content

Commit

Permalink
docs: add Google Cloud Storage publisher docs (#9)
Browse files Browse the repository at this point in the history
Co-authored-by: George Xu <[email protected]>
mahnunchik and georgexu99 authored Nov 17, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent b0d2417 commit a2d931a
Showing 2 changed files with 32 additions and 0 deletions.
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -31,6 +31,7 @@
* [GitHub](config/publishers/github.md)
* [Nucleus](config/publishers/nucleus.md)
* [S3](config/publishers/s3.md)
* [GCS](config/publishers/gcs.md)
* [Snapcraft](config/publishers/snapcraft.md)
* [Hooks](config/hooks.md)

31 changes: 31 additions & 0 deletions config/publishers/gcs.md
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`.

0 comments on commit a2d931a

Please sign in to comment.