Publishing

Initial Setup

This is one time setup that the maintainer will need to do.

NPM setup

npm set init.author.name "Your Name"
npm set init.author.email "[email protected]"

# this will login, or create account if you don't have one
npm adduser
# once you have an account you can use 'npm login'

Bower setup

npm install -g bower
cd path/to/project
bower register numbro git://github.com/BenjaminVanRyseghem/numbro.git
# now all semver tags pushed to github will be found by bower

Publishing A New Version

1. First, git checkout develop && git pull origin develop
2. Then, increment either the major, minor, or patch version as semantically correct by the changes made since the last release. There is a grunt task to increase the version of all the relevant files.

# to increase the patch version number
npm run bump:patch

# to increase the minor version number
npm run bump:minor

# to increase the minor version number
npm run bump:major

#... for more options see https://github.com/stevelacy/gulp-bump

1. Update the changelog. Add an entry for the new version. Add a line for each change and thank the contributor(s).
2. Run npm install to generate the dist files.
3. Make a commit with version number and changelog changes with the message "Release X.X.X"
4. Push the new version as a tag to github/npm. There's a npm script for this.

npm publish

1. Merge develop into master: git push --force-with-lease origin develop:master
2. Push tag: git push --tags
3. Update the webpage. Only a npm add numbro should be necessary. But if file structure changed, ensure that the installation steps are still correct
4. Write a news post for the website
5. Update the cdnjs url according to the documentation
6. Mark tag as release on Github