Skip to content

Commit

Permalink
How to for release
Browse files Browse the repository at this point in the history
  • Loading branch information
Davis W. Frank committed Feb 27, 2011
1 parent 3be0610 commit d7cced2
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
31 changes: 31 additions & 0 deletions HowToRelease.markdown
@@ -0,0 +1,31 @@
# Making a Release of Jasmine Core

Jasmine Core is this Github repo and contains all the core JavaScript code for the Jasmine BDD framework.

It also contains two HTML pages for the Github Pages at http://pivotal.github.com/jasmine.

## The Repo

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 concat all these files in the correct order.

## The Pages

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.

The pages are built with [Frank](https://github.com/blahed/frank). All the source for these pages live in the
pages_source directory.

## Running Specs

Open the file `spec/runner.html` and all specs will run.

## Releasing

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`.
2 changes: 1 addition & 1 deletion pages
Submodule pages updated from 0c35bf to d08ce2

0 comments on commit d7cced2

Please sign in to comment.