This part of the documentation gives you a basic overview of how to help with the development of Raven.js.
Setting up an Environment¶
To run the test suite and run our code linter, node.js and npm are required. If you don’t have node installed, get it here first.
Installing all other dependencies is as simple as:
$ npm install
And if you don’t have Grunt already, feel free to install that globally:
$ npm install -g grunt-cli
Running the Test Suite¶
The test suite is powered by Mocha and can both run from the command line, or in the browser.
From the command line:
$ grunt test
From your browser:
$ grunt run:test
Then visit: http://localhost:8000/test/
The simplest way to compile your own version of Raven.js is with the supplied grunt command:
$ grunt build
By default, this will compile raven.js and all of the included plugins.
If you only want to compile the core raven.js:
$ grunt build.core
Files are compiled into
The documentation is written using reStructuredText, and compiled using Sphinx. If you don’t have Sphinx installed, you can do it using following command (assuming you have Python already installed in your system):
$ pip install sphinx
Documentation can be then compiled by running:
$ make docs
Afterwards you can view it in your browser by running following command and than pointing your browser to http://127.0.0.1:8000/:
$ grunt run:docs
Releasing New Version¶
- Bump version numbers in
$ grunt distThis will compile a new version and update it in the
- Confirm that build was fine, etc.
- Commit new version, create a tag. Push to GitHub.
$ grunt publishto recompile all plugins and all permutations and upload to S3.
$ npm publishto push to npm.
- Confirm that the new version exists behind
- Update version in the
gh-pagesbranch specifically for http://ravenjs.com/.