https://github.com/knownasilya/ember-cli-deploy-gcloud-storage

An Ember-CLI-Deploy plugin to upload assets to Google Cloud Storage.
https://github.com/knownasilya/ember-cli-deploy-gcloud-storage

deployment ember-addon ember-cli-deploy google-cloud-storage storage

Last synced: 2 days ago
JSON representation

An Ember-CLI-Deploy plugin to upload assets to Google Cloud Storage.

• Host: GitHub
• URL: https://github.com/knownasilya/ember-cli-deploy-gcloud-storage
• Owner: knownasilya
• License: mit
• Created: 2016-04-22T13:28:09.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T23:55:20.000Z (about 1 year ago)
• Last Synced: 2024-09-22T02:37:08.186Z (11 days ago)
• Topics: deployment, ember-addon, ember-cli-deploy, google-cloud-storage, storage
• Language: JavaScript
• Size: 3 MB
• Stars: 8
• Watchers: 3
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ember-cli-deploy-gcloud-storage

An Ember-CLI-Deploy plugin to upload assets to Google Cloud Storage (can also be used for Firebase).

[![NPM][npm-badge-img]][npm-badge-link]

[![Build Status][travis-badge]][travis-badge-url]

[![Ember Observer Score][ember-observer-badge]][ember-observer-url]  

[![Ember-CLI Deploy Version][ember-cli-deploy-badge]][ember-cli-deploy-url]

## Compatibility

- Ember.js v3.16 or above

- Ember CLI v2.13 or above

- Node.js v10 or above

## Quick Start

To get up and running quickly, do the following:

- Install [ember-cli-deploy] first.

- Ensure [ember-cli-deploy-build] is installed and configured.

- Install this plugin

```bash

ember install ember-cli-deploy-gcloud-storage

```

- Place the following configuration into `config/deploy.js`

```javascript

ENV['gcloud-storage'] = {

  credentials: {

    private_key: '',

    client_email: '',

  },

  projectId: '',

  bucket: '',

};

```

- Run the pipeline

```bash

ember deploy production

```

## Configuration

- `credentials` - GCP credentials object, `{ private_key, client_email }`, required (can be specified with GCP envs/config).

- `keyFilename` - Alternative configuration to the `credentials` option. Specify the path to the key file downloaded for service account.

- `projectId` - Your GCP project id, required (can be specified with GCP envs, `GCLOUD_PROJECT= ember deploy`).

- `bucket` - A bucket in GCS to store your files, required.

- `bucketFolder` - A folder inside the bucket to place your files, optional.

- `distFiles` - Files that need to be deployed, defaults to all files in the `dist` directory.

- `gzippedFiles` - Files that are already gzipped, hence not requiring more gzipping. This defaults to values from `ember-cli-deploy-gzip`.

- `filePattern` - Applied to the `distFiles` via minimatch.

- `metadata` - Hash of metadata properties to be applied to uploaded files.

- `makePublic` - Boolean, if set to `true` will make the uploaded file public. Default is `false`.

## TODO

- [ ] Create bucket if it doesn't exist

- [ ] Support a manifest file

- [ ] Add more of the options that the s3 plugin has

- [ ] Tests

## Contributing

# See [CONTRIBUTING.md].

See the [Contributing](CONTRIBUTING.md) guide for details.

[npm-badge-img]: https://badge.fury.io/js/ember-cli-deploy-gcloud-storage.svg

[npm-badge-link]: http://badge.fury.io/js/ember-cli-deploy-gcloud-storage

[travis-badge]: https://travis-ci.org/knownasilya/ember-cli-deploy-gcloud-storage.svg

[travis-badge-url]: https://travis-ci.org/knownasilya/ember-cli-deploy-gcloud-storage

[ember-observer-badge]: http://emberobserver.com/badges/ember-cli-deploy-gcloud-storage.svg

[ember-observer-url]: http://emberobserver.com/addons/ember-cli-deploy-gcloud-storage

[ember-cli-deploy-badge]: https://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/plugins/ember-cli-deploy-gcloud-storage.svg

[ember-cli-deploy-url]: http://ember-cli-deploy.github.io/ember-cli-deploy-version-badges/

[ember-cli-deploy]: https://github.com/ember-cli-deploy/ember-cli-deploy

[ember-cli-deploy-build]: https://github.com/ember-cli-deploy/ember-cli-deploy-build

[contributing.md]: CONTRIBUTING.md