Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 2.22 KB

RELEASE.md

File metadata and controls

78 lines (59 loc) · 2.22 KB
Raw

How To version release SIP.js

(These are developer notes.)

(These may not be entirely accurate.)

(Eric Green demands credit for these.)

(So remember that if it's broken, you know who to contact.)

(If you don't know, it's Eric Green.)

  • On your own github, checkout last tagged release on a new branch (note: this can be done on the repo's release branch, instead of making your own)

  • remove all dist files

  • cherry pick commits you want using -x flag (for "hot patch" releases)

  • once ready, test.

  • update version number on master

  • cherry pick version number commit to new branch (or just merge master, if you want everything)

  • build and test.

  • test again

  • add new dist files (git add -f if it complains)

  • commit

  • test npm:

    #!/usr/bin/env bash
set -e
SIPJS_DIR=`pwd`

cd /tmp
rm -rf node_modules
npm install $SIPJS_DIR

node -e "var SIP = require('sip.js'); new SIP.UA({traceSip: true}); setTimeout(process.exit, 2000)"
cd node_modules/sip.js && npm install && npm test

SIPJS_TEST="var SIP = require('sip.js'); var session = new SIP.UA({traceSip: true}).invite('welcome@onsip.com', new Audio());"
SIPJS_TEST+="session.on('accepted', setTimeout.bind(null, window.close, 5000))"
npm install -g browserify smokestack
browserify -r sip.js | cat - <(echo $SIPJS_TEST) | smokestack

# more tests

cd $SIPJS_DIR
set +e

  • test bower:

    #!/usr/bin/env bash
set -e
SIPJS_DIR=`pwd`
SIPJS_HASH=`git rev-parse HEAD`

cd /tmp
rm -rf bower_components
bower install "$SIPJS_DIR/.git#$SIPJS_HASH"

SIPJS_TEST="var session = new SIP.UA({traceSip: true}).invite('welcome@onsip.com', new Audio());"
SIPJS_TEST+="session.on('accepted', setTimeout.bind(null, window.close, 5000))"
npm install -g smokestack
cat ./bower_components/sip.js/dist/sip.min.js <(echo $SIPJS_TEST) | smokestack

# more tests

cd $SIPJS_DIR
set +e

  • push to local github

  • merge (this step and the above one can be skipped if you just do it on the the repo's release branch itself)

  • git tag (your version number)

  • git push --tags

  • get a clean release (as in, fresh clone)

  • npm publish

  • do release notes on github and release!

  • update website