@alrra/travis-scripts - npm Package Compare versions

Comparing version 2.1.0 to 3.0.0

CHANGELOG.md

@@ -1,59 +0,135 @@
-### 2.1.0 (March 28, 2016)
+## 3.0.0 (April 30, 2016)
 
-* [[`8dca462a35`](https://github.com/alrra/travis-scripts/commit/8dca462a3501060b7d75d3f91dc425a9f51dc693)] -
-  Add `set-up-ssh` helper script
-  (see also: [`#19`](https://github.com/alrra/travis-scripts/issues/19)).
+##### Breaking changes
+
+* [[`dab509dcbd`](https://github.com/alrra/travis-scripts/commit/dab509dcbdc10434e4ea1c8d360c9e365a926514)] -
+  Remove support for GitHub access tokens
+  (see also: [`#25`](https://github.com/alrra/travis-scripts/issues/25)).
+* [[`bbd18ad347`](https://github.com/alrra/travis-scripts/commit/bbd18ad34747299aacaa178a9ef8ff50c8f6c629)] -
+  Use a single character for the short command-line options
+  (see also: [`#23`](https://github.com/alrra/travis-scripts/issues/23)).
+
+##### Bug fix
+
+* [[`197c1a78e7`](https://github.com/alrra/travis-scripts/commit/197c1a78e78306fd7ce735ecb989a0833a3b9700)] -
+  Change `update-branch.sh` to allow `master` as the distribution branch
+  (see also: [`#22`](https://github.com/alrra/travis-scripts/issues/22)).
+
+##### Improvements
+
+* [[`5464e442c0`](https://github.com/alrra/travis-scripts/commit/5464e442c02e9bc54d2fa70c5bbf712ca42707ec)] -
+  Make `update-branch.sh`'s `-d/--directory` option optional.
+* [[`def34123a9`](https://github.com/alrra/travis-scripts/commit/def34123a988e8925ddaeff2428f5e9f83b65b06)] -
+  Make log output include name of script being executed.
+  (see also: [`comment#17144757`](https://github.com/alrra/travis-scripts/commit/def34123a988e8925ddaeff2428f5e9f83b65b06#commitcomment-17144757)).
+* Make various documentation related improvements
+  (see also: [`#20`](https://github.com/alrra/travis-scripts/issues/20)).
+
+
+## 2.1.0 (March 28, 2016)
+
+##### Improvements
+
 * [[`850318d739`](https://github.com/alrra/travis-scripts/commit/850318d7399b2813946e31bd9501489285284515)] -
-  Improve log output 
+  Improve log output
   (see also: [`a62dbcdacf`](https://github.com/alrra/travis-scripts/commit/a62dbcdacfc5ee39ce4077ed43b9a911760cc6b8)).
 * Make various documentation related improvements.
 
-### 2.0.0 (February 9, 2016)
+##### New feature
 
+* [[`8dca462a35`](https://github.com/alrra/travis-scripts/commit/8dca462a3501060b7d75d3f91dc425a9f51dc693)] -
+  Add `set-up-ssh` helper script
+  (see also: [`#19`](https://github.com/alrra/travis-scripts/issues/19)).
+
+
+## 2.0.0 (February 9, 2016)
+
+##### Breaking change
+
 * [[`9e81ebdb77`](https://github.com/alrra/travis-scripts/commit/9e81ebdb773f720023f124e5b8b5ae750708f8ec)] -
   Discontinue executing `travis-after-all` internally.
+
+##### New feature
+
 * [[`b52ca7552b`](https://github.com/alrra/travis-scripts/commit/b52ca7552bfc6bee8b713fb9a6ae79f94b87068d)] -
   Make scripts also work with `Deploy Keys`.
 
-### 1.2.2 (January 19, 2016)
 
+## 1.2.2 (January 19, 2016)
+
+##### Improvement
+
 * [[`4ee8e07787`](https://github.com/alrra/travis-scripts/commit/4ee8e0778799cc49bc5b2fd46672fef158f09df4)] -
   Improve usage instructions from `README.md`.
 
+
 ### 1.2.1 (January 19, 2016)
 
+##### Improvement
+
 * [[`e11dabc3a5`](https://github.com/alrra/travis-scripts/commit/e11dabc3a5a7371fbe8d1bf6ae70a094b55c0212)] -
   Fix `npm` install instruction from `README.md`.
 
-### 1.2.0 (January 19, 2016)
 
+## 1.2.0 (January 19, 2016)
+
+##### Improvements
+
 * [[`bbf3350b4e`](https://github.com/alrra/travis-scripts/commit/bbf3350b4edb8ac2eac0e443a24fef9f63c7d586)] -
   Add usage instructions in `README.md`
-  (see also : [`#17`](https://github.com/alrra/travis-scripts/issues/17)).
+  (see also: [`#17`](https://github.com/alrra/travis-scripts/issues/17)).
 * [[`932c35b236`](https://github.com/alrra/travis-scripts/commit/932c35b2364ebda17c65f6e358a41d41334598c0)] -
-  Make minor improvements to the scripts.
+  Make minor improvements.
 
-### 1.1.3 (January 10, 2016)
 
-* Make minor improvements.
+## 1.1.3 (January 10, 2016)
 
-### 1.1.2 (November 8, 2015)
+##### Improvements
 
+* [[`44ac04d39`](https://github.com/alrra/travis-scripts/commit/44ac04d39b835e50c7ceb976b54512d688a97e45)] -
+  Use `https://` where possible.
+
+
+## 1.1.2 (November 8, 2015)
+
+##### Improvement
+
 * [[`509e9ef526`](https://github.com/alrra/travis-scripts/commit/509e9ef5260b8120a11a8aef8b31e30cb99601fa)] -
   Update [`travis-after-all`](https://github.com/alrra/travis-after-all) to `v1.4.4`.
 
-### 1.1.1 (September 20, 2015)
 
+## 1.1.1 (September 20, 2015)
+
+##### Improvement
+
 * [[`1bdd08055f`](https://github.com/alrra/travis-scripts/commit/1bdd08055f60b81ce148ccd7464c9022420c057a)] -
   Update [`travis-after-all`](https://github.com/alrra/travis-after-all) to `v1.4.3`.
 
-### 1.1.0 (September 18, 2015)
 
+## 1.1.0 (September 18, 2015)
+
+##### Improvement
+
 * [[`dfa7d10049`](https://github.com/alrra/travis-scripts/commit/dfa7d10049ce63b87a33c2fbee93cbff62795a1c)] -
   Make scripts immediately stop if something failed.
 
-### 1.0.0 (September 17, 2015)
 
+## 1.0.0 (September 17, 2015)
+
+##### Breaking changes
+
 * [[`e6ad0cb681`](https://github.com/alrra/travis-scripts/commit/e6ad0cb681c03c12df2092ab86d4187d6c080f70)] -
   Remove all the default option values from scripts.
+* [[`727433c628`](https://github.com/alrra/travis-scripts/commit/727433c628f25fdda094bc31b655aa889fd7079a)] -
+  Move scripts into `bin/`.
+* [[`69847ada77`](https://github.com/alrra/travis-scripts/commit/69847ada77dd76a1bf4e00c6bd5e594f65e80b0b)] -
+  Rename script files to have more generic names.
+
+##### Bug fix
+
+* [[`2861a1dde5`](https://github.com/alrra/travis-scripts/commit/2861a1dde5489211e3a08d325f2461654330a7c1)] -
+  Make `commit-changes.sh` push to the specified branch.
+
+##### Improvements
+
 * [[`b06c39b29f`](https://github.com/alrra/travis-scripts/commit/b06c39b29f1f330cd68f2f3b7bd231edf1ab4ee4)] -
@@ -63,15 +139,15 @@ Update [`travis-after-all`](https://github.com/alrra/travis-after-all) to `v1.4.2`.
   Make scripts show all the error messages.
+
+##### New Features
+
 * [[`5554b9a3fc`](https://github.com/alrra/travis-scripts/commit/5554b9a3fc6b09b37df7a95b40438efe08148eb6)] -
   Make `update-branch.sh` allow even a non-root directory to be specified.
-* [[`2861a1dde5`](https://github.com/alrra/travis-scripts/commit/2861a1dde5489211e3a08d325f2461654330a7c1)] -
-  Make `commit-changes.sh` push to the specified branch.
 * [[`2d5dd96e6e`](https://github.com/alrra/travis-scripts/commit/2d5dd96e6ec1190c6963f30a9e780e98fb1e5052)] -
   Make scripts use [`travis-after-all`](https://github.com/alrra/travis-after-all).
-* [[`727433c628`](https://github.com/alrra/travis-scripts/commit/727433c628f25fdda094bc31b655aa889fd7079a)] -
-  Move scripts into `bin/`.
-* [[`69847ada77`](https://github.com/alrra/travis-scripts/commit/69847ada77dd76a1bf4e00c6bd5e594f65e80b0b)] -
-  Rename script files to have more generic names.
 
-### 0.6.1 (December 10, 2014)
 
+## 0.6.1 (December 10, 2014)
+
+##### Bug fix
+
 * [[`17ae1cfbc0`](https://github.com/alrra/travis-scripts/commit/17ae1cfbc01ea0ca80b209a9d251e954d1a67c19)] -
@@ -81,4 +157,7 @@ Fix wrong option name in the help message from `update_site_branch.sh`
 
-### 0.6.0 (December 8, 2014)
 
+## 0.6.0 (December 8, 2014)
+
+##### Breaking change
+
 * [[`5c8c6452c81`](https://github.com/alrra/travis-scripts/commit/5c8c6452c81b894bcdc5a232ebef02c8220b5294)] -
@@ -88,4 +167,7 @@ Allow users to specify the commands that will be executed
 
-### 0.5.1 (December 3, 2014)
 
+## 0.5.1 (December 3, 2014)
+
+##### Improvement
+
 * [[`b76ac792b49`](https://github.com/alrra/travis-scripts/commit/b76ac792b49580cc0b3451480e3858e5317b9eec)] -
@@ -95,4 +177,7 @@ Fix typo in `update_site_branch.sh`
 
-### 0.5.0 (November 29, 2014)
 
+## 0.5.0 (November 29, 2014)
+
+##### Breaking change
+
 * [[`14ce4253920`](https://github.com/alrra/travis-scripts/commit/14ce42539205135389a7ea555f4a624a9a505878)] -
@@ -102,24 +187,39 @@ Allow users to specify the default branch name
 
-### 0.4.0 (November 8, 2014)
 
+## 0.4.0 (November 8, 2014)
+
+##### Breaking change
+
 * [[`f41f5abe98`](https://github.com/alrra/travis-scripts/commit/f41f5abe982971342fa9b1de6fee4cdc58a28b7d)] -
   Make scripts check if the pull request is targeting the `master` branch.
 
-### 0.3.0 (November 8, 2014)
 
+## 0.3.0 (November 8, 2014)
+
+##### Breaking change
+
 * [[`fb54392f89`](https://github.com/alrra/travis-scripts/commit/fb54392f89d99a7dcc4bf268580cf28bbc59fcb9)] -
   Make `update_site_branch.sh` remove the `.travis.yml` file.
 
-### 0.2.2 (November 7, 2014)
 
+## 0.2.2 (November 7, 2014)
+
+##### Improvement
+
 * [[`26dcf013a2`](https://github.com/alrra/travis-scripts/commit/26dcf013a24e6a99e8d057939915e98d04f70ffe)] -
   Use better output message in `commit_build_changes.sh`.
 
-### 0.2.1 (November 7, 2014)
 
+## 0.2.1 (November 7, 2014)
+
+##### Improvement
+
 * [[`f876d6e060`](https://github.com/alrra/travis-scripts/commit/f876d6e0605e66fa494b40c3908f8b468088e8c8)] -
   Make scripts only output the strictly necessary content.
 
-### 0.2.0 (November 6, 2014)
 
+## 0.2.0 (November 6, 2014)
+
+##### Breaking changes
+
 * [[`b5ecd3196e`](https://github.com/alrra/travis-scripts/commit/b5ecd3196e43001719461ad2a4f945972d789f2f)] -
@@ -130,2 +230,3 @@ Make `update_site_branch.sh` more generic.
 
-### 0.1.0 (November 5, 2014)
+
+## 0.1.0 (November 5, 2014)

doc/github-deploy-keys.md

@@ -1,2 +0,2 @@
-# Setup the SSH keys
+# Set up the SSH keys
 
@@ -12,3 +12,3 @@ #### 1. Enable Travis CI
 
-#### 2. Setup the SSH keys
+#### 2. Set up the SSH keys
 
@@ -134,4 +134,4 @@ ##### 2.1. Generate the SSH keys
 
-         $(npm bin)/set-up-ssh -k "$encrypted_XXXXXXXXXXXX_key" \
-                               -iv "$encrypted_XXXXXXXXXXXX_iv" \
+         $(npm bin)/set-up-ssh --key "$encrypted_XXXXXXXXXXXX_key" \
+                               --iv "$encrypted_XXXXXXXXXXXX_iv" \
                                --path-encrypted-key ".travis/github_deploy_key.enc"
@@ -181,3 +181,4 @@ ```
 
-I personally don't recommend [specifying their values directly](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-.travis.yml)
+I personally don't recommend [specifying their values
+directly](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-.travis.yml)
 as that would mean they will be public. Instead, you should encrypt
@@ -184,0 +185,0 @@ them by generating a secure key using the Travis CLI:

doc/handle-multiple-jobs.md

 # Handle multiple jobs
 
-If your build has mutiple jobs, you will want these travis scripts
-to be executed only one, and for that you will need to use
+If your build has multiple jobs, you will want these travis scripts
+to be executed only once, and for that you will need to use
 [`travis-after-all`](https://github.com/alrra/travis-after-all#readme).
@@ -6,0 +6,0 @@

doc/install.md

@@ -9,2 +9,5 @@ # Install
 
+:warning: You will need a version of `npm` greater than `2.7.0` 
+in order for the above to work!
+
 --
@@ -11,0 +14,0 @@

doc/usage.md

@@ -6,4 +6,5 @@ # Usage
 Here’s an example that runs `npm run build` against the `master`
-branch whenever Travis CI completes a run, after which the resulting
-`build` directory gets deployed to the `gh-pages` branch:
+branch whenever Travis CI completes a run, after which, the content
+from the resulting `dist` directory gets pushed to the `gh-pages`
+branch:
 
@@ -14,8 +15,8 @@ ```yml
 
-    # If deploy keys are used, add here the SSH commands, see:
-    # https://github.com/alrra/travis-scripts/tree/master/doc/github-deploy-keys.md#26-setup-the-ssh-key-for-travis-ci
+    # Add the SSH-related commands here, see:
+    # https://github.com/alrra/travis-scripts/blob/master/doc/github-deploy-keys.md#26-set-up-ssh-connection-for-travis-ci
 
     $(npm bin)/update-branch --commands "npm run build"
                              --commit-message "Hey GitHub, this content is for you! [skip ci]"
-                             --directory "build"
+                             --directory "dist"
                              --distribution-branch "gh-pages"
@@ -22,0 +23,0 @@ --source-branch "master"

package.json

@@ -24,10 +24,10 @@ {
   "devDependencies": {
-    "babel-cli": "^6.4.0",
+    "babel-cli": "^6.7.5",
     "babel-plugin-transform-async-to-generator": "^6.4.0",
-    "babel-plugin-transform-runtime": "^6.4.0",
+    "babel-plugin-transform-runtime": "^6.7.5",
     "babel-polyfill": "^6.3.14",
     "babel-preset-es2015": "^6.3.13",
     "babel-runtime": "^6.3.19",
-    "js-yaml": "^3.4.6",
-    "tap": "^5.0.0",
+    "js-yaml": "^3.6.0",
+    "tap": "^5.7.1",
     "tap-mocha-reporter": "0.0.24",
@@ -38,2 +38,3 @@ "travis-after-all": "^1.4.4"
   "keywords": [
+    "automation",
     "travis",
@@ -48,6 +49,5 @@ "travis-ci",
     "print-test-text": "printf \"%s\" \"$npm_package_config_test_text\"",
-    "pretest": "([ -z $GH_TOKEN ] && npm link && set-up-ssh -k \"$encrypted_18a7d42f6a87_key\" -iv \"$encrypted_18a7d42f6a87_iv\" --path-encrypted-key \".travis/github_deploy_key.enc\" || exit 0) && rm -rf dist_test && babel test --out-dir dist_test",
-    "test": "node dist_test/main.js | tap-mocha-reporter spec"
+    "test": "./test/main.sh"
   },
-  "version": "2.1.0"
+  "version": "3.0.0"
 }

README.md

@@ -7,11 +7,8 @@ # travis-scripts
 
-## Usage
+## Documentation
 
-* [Install](doc/install.md)
-* Allow access to the repository
-  * [Setup the SSH keys](doc/github-deploy-keys.md)
-  * or [use an access token](doc/github-access-token.md)
-    (not recommended, as it's less secure)
-* [Usage](doc/usage.md)
-* [Handle multiple jobs](doc/handle-multiple-jobs.md)
+* :package: [Install](doc/install.md)
+* :closed_lock_with_key: [Set up the SSH keys](doc/github-deploy-keys.md)
+* :repeat: [Usage](doc/usage.md)
+* :repeat_one: [Handle multiple jobs](doc/handle-multiple-jobs.md)
 
@@ -18,0 +15,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

37649

decreased by-6.64%

Number of package files

13

decreased by-7.14%

Number of lines in readme file

18

decreased by-14.29%

No dependency changes