Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.74 KB

DEPLOYING.md

File metadata and controls

52 lines (34 loc) · 1.74 KB

How to deploy keen.js

Preparing the release

  1. Be certain that version has been updated in package.json.
  2. Create a new CHANGELOG.md entry with information about this release (example).
  3. Update README.md docs/README.md, and docs/installation.md files to reflect what the new CDN URLs and library versions will be once this release is live.
  4. Commit updates from these steps now.
  5. Be certain to run gulp build so that the files you commit and deploy from ./dist are in fact the latest and greatest.

Cutting the release

  • Force-add the dist folder: git add .dist/ -f
  • Commit this: git commit -m "v{version} release"
  • Create a new tag: git tag v{version} (ex: v3.3.1)
  • Push this tag: git push origin v{version} (ex: v3.3.1)

Need a do-over? Tags can be overwritten with the -f flag.

Verify the release

  • Check the repo releases and download the ZIP file to ensure that the dist folder and built files are there. If so, continue...

Deploying to NPM

Beware: this is a one-time deal. Releases cannot be re-published!

  • Deploy this tag the npm: npm publish

Deploying to AWS:

Run this command with the appropriate AWS and aws_secret keys:

$ export AWS_KEY={AWS KEY}
$ export AWS_SECRET={AWS SECRET}
$ gulp deploy

This will test, build, and deploy the files to AWS.

This blog post was especially helpful with information on publishing to npm and bower.

One last step!

Now that you've finished, un-commit the dist/ folder.

git reset --soft HEAD~1
git rm --cached ./dist