Skip to content

Commit

Permalink
Added release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrvisser committed Apr 2, 2014
1 parent a1a47dd commit da78096
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
The `rest` module for OAE.

This is a stand-alone module that can be used to communicate with a live OAE instance through its REST endpoints.
This is a stand-alone module that can be used to communicate with a live OAE instance through its REST endpoints.

### Releasing

This module is versioned the same as the [Hilary](https://github.com/oaeproject/Hilary) project. When a new version of Hilary is released, a matching version of this module should be released. To keep the versions in sync, we do the following:

* Every release is post-fixed with `-N` starting from `-1`. Any `<hilary version>-N` release of this module will work with `<hilary version>` of Hilary. The `-N` postfix is only for maintenance things such as updating build scripts or critical package.json scripts
* Whenever there is a new Hilary release, we release a compatible version of this module with the same version

To do that, we use the [grunt-release](https://github.com/geddski/grunt-release) plugin, however we do some additional acrobatics to follow the above process:

1. To update just the pre-release version of this module, run: `grunt release-version:prerelease`
2. To do a patch-version release of this module, run: `grunt release-version:patch`
3. To do a minor-version release of this module, run: `grunt release-version:minor`
4. To do a major-version release of this module, run: `grunt release-version:major`

Therefore if you are on version `4.4.0-3` and you need to upgrade the module for a `5.0.0` release of Hilary, you run the following:

`grunt release-version:major`, and that will release and publish version `5.0.0-1` of this module to NPM.

0 comments on commit da78096

Please sign in to comment.