From a2d931a99b42545be3df7683d921dd14d67e9b23 Mon Sep 17 00:00:00 2001 From: Evgeny Date: Fri, 17 Nov 2023 12:57:02 -0600 Subject: [PATCH] docs: add Google Cloud Storage publisher docs (#9) Co-authored-by: George Xu --- SUMMARY.md | 1 + config/publishers/gcs.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 config/publishers/gcs.md diff --git a/SUMMARY.md b/SUMMARY.md index 77bc129..4153d5f 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -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) diff --git a/config/publishers/gcs.md b/config/publishers/gcs.md new file mode 100644 index 0000000..6ab847b --- /dev/null +++ b/config/publishers/gcs.md @@ -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`.