@alrra/travis-scripts - npm Package Compare versions

Comparing version 1.1.3 to 1.2.0

CHANGELOG.md

@@ -0,1 +1,9 @@
+### 1.2.0 (January 19, 2016)
+
+* [[`bbf3350b4e`](https://github.com/alrra/travis-scripts/commit/)] -
+  Add usage instructions in `README.md`
+  (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.
+
 ### 1.1.3 (January 10, 2016)
@@ -2,0 +10,0 @@

package.json

@@ -26,5 +26,5 @@ {
   "devDependencies": {
-    "babel-cli": "^6.3.17",
-    "babel-plugin-transform-async-to-generator": "^6.3.13",
-    "babel-plugin-transform-runtime": "^6.3.13",
+    "babel-cli": "^6.4.0",
+    "babel-plugin-transform-async-to-generator": "^6.4.0",
+    "babel-plugin-transform-runtime": "^6.4.0",
     "babel-polyfill": "^6.3.14",
@@ -51,3 +51,3 @@ "babel-preset-es2015": "^6.3.13",
   },
-  "version": "1.1.3"
+  "version": "1.2.0"
 }

README.md

@@ -5,1 +5,52 @@ # travis-scripts
 [![devDependency Status](https://david-dm.org/alrra/travis-scripts/dev-status.svg)](https://david-dm.org/alrra/travis-scripts#info=devDependencies)
+
+## How to use
+
+1. Save `travis-scripts` as a `devDependency` to `package.json`:
+
+    ```sh
+    $ npm install travis-scripts --save-dev
+    ```
+
+2. [Generate a GitHub application token](https://github.com/settings/applications/new)
+for command-line use. See [GitHub’s documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use/)
+for more info.
+
+3. [Install the Travis client](https://docs.travis-ci.com/user/encryption-keys/#Usage)
+and run:
+
+    ```sh
+    $ travis encrypt -r "<username>/<repository>" \
+      GH_TOKEN="<your_github_access_token>" \
+      GH_USER_EMAIL="<your_email>" \
+      GH_USER_NAME="<your_name>" \
+      --add env.global
+    ```
+
+    This adds an entry to your `.travis.yml` file:
+
+    ```yaml
+    env:
+      global:
+        - secure: "<secure_key>"
+    ```
+
+4. Specify the commands to be run in `.travis.yml`.
+
+    Here’s an example that runs `npm install && 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:
+
+    ```yml
+    after_success:
+      - $(npm bin)/update-branch --commands "npm install && npm run build"
+                                 --commit-message "Hey GitHub, this content is for you! [skip ci]"
+                                 --directory "build"
+                                 --distribution-branch "gh-pages"
+                                 --source-branch "master"
+    ```
+
+Note that these scripts use [`travis-after-all`](https://github.com/alrra/travis-after-all#readme) 
+to ensure this is only executed once, even when there are multiple jobs
+in the build matrix.

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

Improved metrics

Total package byte prevSize

22291

increased by11.66%

Number of lines in readme file

56

increased by1020%

No dependency changes