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 module is versioned the same as the 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 plugin, however we do some additional acrobatics to follow the above process:
- To update just the pre-release version of this module, run:
grunt release-version:prerelease
- To do a patch-version release of this module, run:
grunt release-version:patch
- To do a minor-version release of this module, run:
grunt release-version:minor
- 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:
sh release.sh
, enter your GitHub username and password, enter the release type as major
, and that will release and publish version 5.0.0
of this module to NPM.