Skip to content

docs: add Google Cloud Storage publisher docs #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,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)

## Advanced
Expand Down
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`.