Added a how to publish description

This commit is contained in:
jos 2014-05-31 21:08:17 +02:00
parent ff6e54b715
commit 4ea91d45b4
1 changed files with 91 additions and 0 deletions

91
misc/how_to_publish.md Normal file
View File

@ -0,0 +1,91 @@
# How to publish jsoneditor
This document describes the steps required to publish a new version of jsoneditor.
## Update version number
Update the version number in both package.json and bower.json.
## Update history
Update the date and version number in the file HISTORY.md. Verify whether all
changes in the new version are described.
## Build library
Build the build (jsoneditor.js, jsoneditor.css, ...) files by running:
npm run build
After the build is complete, verify if the files are updated and contain the
correct date and version number in the header.
## Test
Test whether the npm library is ok by installing it locally:
cd ../tmp-folder
npm install ../mathjs
Check whether the examples in the library work ok, and whether the necessary
files are included.
## Commit
- Commit the final code.
- Merge the develop branch into the master branch.
- Push to github.
If everything is well, create a tag for the new version, like:
git tag v1.2.4
git push --tags
## Publish
Publish to npm:
npm publish
Publish at cdnjs: test after 30 to 60 minutes whether the new version is
published at cdnjs (should auto update).
## Test published libraries
Install the libraries locally and test whether they work correctly:
cd tmp-folder
npm install mathjs
bower install mathjs
## Put zip file to website
Create a zipped file of the library by running
gulp zip
Add the file to the `downloads` folder of the website.
## Update version number
Switch to the develop branch, and update the version numbers in package.json and
bower.json to a new snapshot version, like
1.2.5-SNAPSHOT
commit and push the changes.
## Done
Congrats, be proud.