diff --git a/DEVELOPERS.md b/DEVELOPERS.md index d22d8a3f..c1d3ab24 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -9,3 +9,59 @@ Download from [here](https://dl.google.com/closure-compiler/compiler-latest.zip) unzip -o compiler-latest.zip Set `$JS_COMPILER` to `${HOME}/compiler.jar`. + + +## Release Steps + +### Tag the release + +E.g. by doing + +``` +git tag -a v0.9.7 -m "tagged release" +``` + +before you commit. (Add the hash of a commit at the end of the above to tag at a later time.) + + +### Draft a release on GitHub + +Go to 'releases' and 'Draft a new release' (adding some release notes is nice!). + + +### Publish to npm + +In the `package` directory do + +``` +make publish +``` + +(This requires your npm user to have publishing priviledges for the package on npm.) + + +### Build for browsers + +In the root directory, do + +``` +make all +``` + +which will package the library for browser use into the `build` directory. + + +### Copy over to AutobahnJSbuilt + +Just copy over the contents of the `build` directory to the AutobahnJSbuilt repo, tag and commit. + + +### Upload to S3 + +Dp + +``` +scons publish +``` + +to upload the built version to S3.