ember-cli-s3-sync - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

CHANGELOG.md

 # ember-cli-s3-sync Changelog
+
+### 0.0.5
+
+
+
+* [FEATURE] allow default cli-args when running custom scripts during deploy process
+
 ### 0.0.4
@@ -3,0 +10,0 @@

lib/tasks/extra-step.js

 'use strict';
 
-var command = require('../utils/command');
+var command = require('../utils/cmd-tool');
 var RSVP    = require('rsvp');
@@ -5,0 +5,0 @@ var chalk   = require('chalk');

package.json

 {
   "name": "ember-cli-s3-sync",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "private": false,
@@ -5,0 +5,0 @@ "directories": {

README.md

@@ -33,4 +33,4 @@ # Ember-cli-s3-sync [![Build Status](https://travis-ci.org/Vestorly/ember-cli-s3-sync.svg?branch=command_line_args)](https://travis-ci.org/Vestorly/ember-cli-s3-sync)
 ## How to use
-`ember deploy:s3 --environment=development --aws-key=12345 --aws-secret=asdfasdf --aws-bucket=buckets-o-fun`
-  - this builds a development version of your app and deploys all files in the `/dist` directory to the S3 bucket "buckets-o-fun"
+`ember deploy:s3 --environment=production --aws-key=12345 --aws-secret=asdfasdf --aws-bucket=buckets-o-fun`
+  - this builds a production version of your app and deploys all files in the `/dist` directory to the S3 bucket "buckets-o-fun"
 
@@ -49,3 +49,3 @@ `ember deploy:s3`
 
-**notes** camelCase args are okay but they'll be converted to their dasherized version.
+**notes:** camelCase args are okay but they'll be converted to their dasherized version.
 
@@ -85,2 +85,3 @@ ## Configuring deployment
 If you want the deploy process to prompt a user for additional options to be merged in for instantiating the S3 Object:
+<br>
 Uses the [inquirer node module](https://github.com/SBoudrias/Inquirer.js).
@@ -108,3 +109,2 @@ ```javascript
 You can run scripts throughout the deploy process. These scripts must exit their process for the deploy to continue running.
-`beforeBuild` and `afterBuild` are *not* run if you use the `--skip-build` flag.
 ```javascript
@@ -115,8 +115,4 @@ { // deploy/config.js
     {
-      command: 'curl -I http://my-site.nyc?deploy=start',
-      // if the cli arg `some-option` is passed in with `ember deploy:s3`.
-      //   e.g. `ember deploy:s3 --header='X-Update: 1'`
-      // then `--some-option=hey` will be included with this command.
-      //   e.g. `curl -I http://my-site.nyc?deploy=start --header 'X-Update: 1'`
-      includeOptions: ['some-option'],
+      command: 'curl http://my-site.nyc?new_build=start', // base command to run
+      includeOptions: ['someOption', 'anotherOption'], // options to include as cli-args for base command
       fail: false // whether a non 0 exit code should halt the deploy process
@@ -138,6 +134,29 @@ }
 
+#### Example Deploy Steps:
+**providing default cli-arguments to run with your custom scripts:**
+<br>
+Running: `ember deploy:s3`
+```javascript
+{ // deploy/config.js
+  ...
+  beforeDeploy: [
+    { 
+      command: 'curl http://httpbin.com/headers',
+      includeOptions: ['compressed', { header: 'X-Forwarded-For: mysite.com' }, { head: true }, 'beh'],
+      fail: false 
+    }
+  ],
+  ...
+}
+```
+will run the following command, waiting for it to exit before deploy assets to S3:
+<br>
+`curl http://httpbin.com/headers --header "X-Forwarded-For: mysite.com" --head`
+
+**notes:** `beforeBuild` and `afterBuild` are not run if you use `--skip-build` flag
+
 ## TODO
-- [ ] 100% test coverage
+- [ ] better test coverage
 - [ ] write documentation for each function
-- [ ] write documentation describing flow, configurable options, general how to use
+- [x] write documentation describing flow, configurable options, general how to use
 - [x] ability to save config file
@@ -147,6 +166,7 @@ - [x] ability to generate `config-s3.js` for deploy configuration
 - [ ] ability to sync individual files to s3 bucket
-- [ ] ability to create bucket if specified bucket doesn't exist
 - [ ] ability to do a dryrun
 - [x] ability to skip build task and just deploy a specified directory
-- [ ] update s3 with file's ContentMD5, preferrably async after upload
+- [x] support gzipped files
+- [ ] ability to set meta data (headers) for files, such as `Expires`
+- [ ] update s3 with file's ContentMD5
 

No alert changes

Improved metrics

Total package byte prevSize

55978

increased by4.44%

Lines of code

1411

increased by4.21%

Number of lines in readme file

166

increased by13.7%

No dependency changes