[go: up one dir, main page]

Skip to content

Latest commit

 

History

History
103 lines (53 loc) · 2.05 KB

how_to_publish.md

File metadata and controls

103 lines (53 loc) · 2.05 KB

How to publish math.js

This document describes the steps required to publish a new version of math.js.

Update version number

Update the version number package.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 distribution files ./dist/math.js and ./dist/math.min.js by running:

npm run build

After the build is complete, verify if the files are created and contain the correct date and version number in the header.

Check whether there are new markdown files generated in ./docs and add if so add them to git.

Test

Test whether the library works correctly by running the tests:

npm test

Test whether the npm library is ok by installing it locally:

cd ../tmp-folder
npm install ../mathjs

Check whether the library works and looks ok.

Commit

  • Commit the final code.
  • Merge the develop branch into the master branch.
  • Push to github.

Now go to travis-ci and verify if the tests run fine there as well:

https://travis-ci.org/josdejong/mathjs

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

No need to publish for bower: The library is already published because of the new version tag.

No need to publish at cdnjs: should be updated automatically by the owners of cdnjs. This is currently done manually and can easily take up to a day before updated.

Test published libraries

Install the libraries locally and test whether they work correctly:

cd tmp-folder
npm install mathjs
bower install mathjs

Update the website

Wait until the new version of math.js is available on cdnjs.org.

The website is located in the gh-pages branch of the project. Follow the readme in the gh-pages branch on how to update the website.

Update the REST API

Update the mathjs-rest project (served at http://api.mathjs.org).

Back to develop

Switch to the develop branch

Done

Time to drink a beer.