admin/jasmine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Release readme

Browse Source
This commit is contained in:
Davis W. Frank
2011-06-21 20:19:28 -07:00
parent e113c338d0
commit a4522e4dce
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Release.markdown
View File

@@ -8,6 +8,14 @@ We attempt to stick to [Semantic Versioning](). Most of the time, development sh
The current version lives in the file `src/version.json`. This file should be set to the version that is _currently_ under development. That is, if version 1.0.0 is the current release then version should be incremented say, to 1.1.0. The current version lives in the file `src/version.json`. This file should be set to the version that is _currently_ under development. That is, if version 1.0.0 is the current release then version should be incremented say, to 1.1.0.
Follow the instructions in `Contribute.markdown` during development. Follow the instructions in `Contribute.markdown` during development.
## Update the Github Pages (as needed)
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/pages_source` directory.
## Release ## Release
@@ -17,14 +25,8 @@ When ready to release - specs are all green and the stories are done:
1. Update any comments on the public interfaces 1. Update any comments on the public interfaces
1. `rake doc` - builds the `jsdoc` pages 1. `rake doc` - builds the `jsdoc` pages
1. Update any links or top-level landing page for the Github Pages 1. Update any links or top-level landing page for the Github Pages
1. `rake standalone` - builds the standalone distribution ZIP file
1. `rake build_pages` - builds the Github Pages 1. `rake build_pages` - builds the Github Pages
1. `rake standalone_safe` - builds the standalone distribution ZIP file 1. `rake release` - tags the repo with the version, makes the gem, pushes the gem to Rubygems.org
There should be a post to Pivotal Labs blog and a tweet to that link.
## The Github 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.