ember-cli-deploy-alioss v2.0.0

ember-cli-deploy-alioss

An ember-cli-deploy plugin to upload files to Aliyun OSS （阿里云对象储存）.

This plugin is originally a fork from ember-cli-deploy-s3 to setup 阿里云对象存储 Aliyun OSS. All credits go to developers in ember-cli-deploy-s3.

Aliyun OSS Policy Requirements

Make sure to enable your bucket's ACL to public read.

Quick Start

To get up and running quickly, do the following:

• Ensure ember-cli-deploy-build is installed and configured.

• Install this plugin

$ ember install ember-cli-deploy-alioss

• Place the following configuration into config/deploy.js

ENV.alioss = {
  accessKeyId: '<your-oss-access-key>',
  secretAccessKey: '<your-oss-secret>',
  bucket: '<your-oss-bucket>',
  region: '<the-region-your-oss-bucket-is-in>'
}

• Run the pipeline

$ ember deploy

ember-cli-deploy Hooks Implemented

For detailed information on what plugin hooks are and how they work, please refer to the Plugin Documentation.

• configure
• upload

Configuration Options

For detailed information on how configuration of plugins works, please refer to the Plugin Documentation.

accessKeyId (required)

The OSS access key for the user that has the ability to upload to the bucket.

Default: undefined

secretAccessKey (required)

The OSS secret for the user that has the ability to upload to the bucket.

Default: undefined

bucket (required)

The OSS bucket that the files will be uploaded to.

Default: undefined

region (required)

The region the OSS bucket is located in.

Default: undefined

acl

The ACL to apply to the objects.

Default: public-read

prefix

A directory within the bucket that the files should be uploaded in to.

Default: ''

filePattern

Files that match this pattern will be uploaded to S3. The file pattern must be relative to distDir.

Default: '**/*.{js,css,png,gif,ico,jpg,map,xml,txt,svg,swf,eot,ttf,woff,woff2}'

distDir

The root directory where the files matching filePattern will be searched for. By default, this option will use the distDir property of the deployment context, provided by ember-cli-deploy-build.

Default: context.distDir

distFiles

The list of built project files. This option should be relative to distDir and should include the files that match filePattern. By default, this option will use the distFiles property of the deployment context, provided by ember-cli-deploy-build.

Default: context.distFiles

gzippedFiles

The list of files that have been gziped. This option should be relative to distDir. By default, this option will use the gzippedFiles property of the deployment context, provided by ember-cli-deploy-gzip.

This option will be used to determine which files in distDir, that match filePattern, require the gzip content encoding when uploading.

Default: context.gzippedFiles

manifestPath

The path to a manifest that specifies the list of files that are to be uploaded to S3.

This manifest file will be used to work out which files don't exist on S3 and, therefore, which files should be uploaded. By default, this option will use the manifestPath property of the deployment context, provided by ember-cli-deploy-manifest.

Default: context.manifestPath

Prerequisites

The following properties are expected to be present on the deployment context object:

• distDir (provided by ember-cli-deploy-build)
• distFiles (provided by ember-cli-deploy-build)
• gzippedFiles (provided by ember-cli-deploy-gzip)
• manifestPath (provided by ember-cli-deploy-manifest)

Running Tests

• npm test