jasmine/HowToRelease.markdown

30 lines
1.6 KiB
Markdown
Raw Normal View History

2011-02-27 22:22:53 +00:00
# Making a Release of Jasmine Core
2011-03-09 02:39:13 +00:00
'Jasmine' is the Github repo for Jasmine Core and contains all the JavaScript code for the Jasmine BDD framework.
2011-02-27 22:22:53 +00:00
It also contains two HTML pages for the Github Pages at http://pivotal.github.com/jasmine.
## The Repo
2011-03-09 02:39:13 +00:00
All of the JS for Jasmine is in the src directory. The specs for each file are in the specs directory. There are rake tasks to build the various files for distribution.
2011-02-27 22:22:53 +00:00
2011-03-09 02:39:13 +00:00
## Running Specs
2011-02-27 22:22:53 +00:00
2011-03-09 02:39:13 +00:00
There are rake tasks to help with getting green:
2011-02-27 22:22:53 +00:00
2011-03-09 02:39:13 +00:00
* `rake spec:browser` opens `spec/runner.html` in the default browser. Please run this in at least Firefox and Chrome before comitting
* `rake spec:node` runs all the Jasmine specs in Node.js
* `rake jasmine:lint` runs all the files through JSHint and will complain about potential viable issues with your code. Fix them.
2011-02-27 22:22:53 +00:00
2011-03-09 02:39:13 +00:00
## The Pages
2011-02-27 22:22:53 +00:00
2011-03-09 02:39:13 +00:00
Github pages have to exist in a branch called gh-pages in order for their app to serve them. This repo adds that branch as a submodule under the `pages` directory. This is a bit of a hack, but it allows us to work with the pages and the source at the same time and with one set of rake tasks.
If you want to submit changes to this repo and aren't a Pivotal Labs employee, you can fork and work in the gh-pages branch. You won't be able to edit the pages in the submodule off of master.
2011-02-27 22:22:53 +00:00
2011-03-09 02:39:13 +00:00
The pages are built with [Frank](https://github.com/blahed/frank). All the source for these pages live in the pages_source directory.
2011-02-27 22:22:53 +00:00
## Releasing
2011-03-09 02:39:13 +00:00
Once all specs are green and you've updated the version in `version.json`, you need to run the rake task to make a distribution: `rake jasmine:dist`.