ember-cli-deploy-cdn77
v0.1.0
Published
An ember-cli-deploy plugin to invalidate CDN77 cache.
Downloads
2
Maintainers
Readme
ember-cli-deploy-cdn77
An ember-cli-deploy plugin to invalidate cached files on CDN77
This plugin invalidates one or more files in CDN77 CDN resource. It is primarily useful for invalidating an outdated index.html
, but can be configured to invalidate any other files as well.
What is an ember-cli-deploy plugin?
A plugin is an addon that can be executed as a part of the ember-cli-deploy pipeline. A plugin will implement one or more of the ember-cli-deploy's pipeline hooks.
For more information on what plugins are and how they work, please refer to the Plugin Documentation.
Quick Start
To get up and running quickly, do the following:
Install this plugin
$ ember install ember-cli-deploy-cdn77
Place the following configuration into
config/deploy.js
ENV.cloudfront = { login: '<your-cdn77-login-email>', apiToken: '<your-cdn77-api-token>', cdnId: '<your-cdn77-cdn-id>' }
Run the pipeline with the activation flag
$ ember deploy production --activate
Installation
Run the following command in your terminal:
ember install ember-cli-deploy-cdn77
ember-cli-deploy Hooks Implemented
For detailed information on what plugin hooks are and how they work, please refer to the Plugin Documentation.
configure
didActivate
Configuration Options
For detailed information on how configuration of plugins works, please refer to the Plugin Documentation.
login (required
)
This is the email address you use to log into the CDN77 control panel.
apiToken (required
)
This is the API token retrieved from the Profile > API Token section of your CDN77 control panel.
cdnId (required
)
This is the number that identifies the CDN resource you would like to invalidate. Find it near the top of the page when viewing the CDN resource in your CDN77 control panel.
objectPaths
Object paths contained in this array will be invalidated on CDN77. Each object path must be relative to the CDN77 CDN resource root and begin with /
.
Default: ['/index.html']
Disable in Selected Environments
If your application doesn't need CDN77 invalidation in an environment where you do need to run other activation hooks, it is possible to whitelist the plugins that you do want ember-cli-deploy to run. For an application using the ember-cli-deploy-aws-pack for example, the whitelist would look like this when excluding ember-cli-deploy-cdn77:
ENV.plugins = ['build', 'gzip', 's3', 'manifest'];
While this may not be ideal for complicated deploy processes with many plugins, there is an effort currently underway to add per-plugin disabling to ember-cli-deploy: https://github.com/ember-cli-deploy/ember-cli-deploy/pull/349
Why ember build
and ember test
don't work
Since this is a node-only ember-cli addon, this package does not include many files and dependencies which are part of ember-cli's typical ember build
and ember test
processes.