Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.08 KB

gcs.md

File metadata and controls

65 lines (48 loc) · 2.08 KB
Raw
description
Publishing your Electron app artifacts to a Google Cloud Storage bucket.

Google Cloud Storage

{% hint style="info" %} This Publisher was added in Electron Forge v7.1.0. {% endhint %}

The Google Cloud Storage target publishes all your artifacts to a Google Cloud Storage bucket.

Installation

npm install --save-dev @electron-forge/publisher-gcs

Usage

To use @electron-forge/publisher-gcs, add it to the publishers array in your Forge configuration:

{% code title="forge.config.js" %}

module.exports = {
  // ...
  publishers: [
    {
      name: '@electron-forge/publisher-gcs',
      config: {
        storageOptions: {
          // add additional Storage constructor parameters here
          projectId: 'my-project-id'
        },
        bucket: 'my-bucket',
        folder: 'custom-folder-name',
        public: true
      }
    }
  ]
};

{% endcode %}

Additional configuration options are documented in PublisherGCSConfig.

To pass options into the Google Cloud Storage SDK's Storage constructor, use the config.storageOptions parameter.

Output location

When executed, the Publisher will publish to your GCS bucket under the following key:

${config.folder || version}/${artifactName}

{% 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 %}

Authentication

Under the hood, the Google Cloud Storage Publisher uses the @google-cloud/storage SDK and its associated authentication options.

We recommend following Google's authentication documentation for client libraries to get authentication configured.