Skip to content

Commit

Permalink
polish for release
Browse files Browse the repository at this point in the history
  • Loading branch information
Tobias Oberstein committed Jan 12, 2017
1 parent 3976650 commit b7a1165
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 36 deletions.
10 changes: 9 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,22 @@ clean:
rm -rf ./node_modules
rm -f .sconsign.dblite

requirements:
pip install scons boto taschenmesser

build: build_browser build_npm

build_browser:
scons

build_npm:
@echo "Ok, nothing to build for npm!"
@echo "Ok, npm doesn't need a build step"

publish: publish_browser publish_npm

publish_browser:
scons publish
git -C ../autobahn-js-built pull
cp ./build/* ../autobahn-js-built
@echo "Now commit and push autobahn-js-built!"

Expand Down
53 changes: 19 additions & 34 deletions doc/release-process.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,35 @@
# Releasing Autobahn|JS

## Release Steps

Autobahn is release to the following locations:
Autobahn is released to the following locations:

1. On S3, here https://autobahn.s3.amazonaws.com/autobahnjs/latest/autobahn.min.jgz
2. On NPM, here https://www.npmjs.com/package/autobahn
3. On GitHub, here https://github.com/crossbario/autobahn-js-built

### Update the release number in the repo
## Release Steps

### Test

Start a local Crossbar.io node with a default configuration (`crossbar init && crossbar start`). Then do

```
make test
```

### Bump version

Update 'package/package.json' with the new release number.
Update `package.json` with the new release number.


### Build for browsers
### Build

In the root directory, do

```
make all
make build
```

which will package the library for browser use into the `build` directory.
which will package the library for browser use into the `build` directory. For npm, there is nothing to build.


### Tag the release
Expand All @@ -35,35 +43,12 @@ 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

If your comment for the tagging did not include "tagged release", then you need to manually draft a release. Go to 'releases' and 'Draft a new release' (adding some release notes is nice!).

Otherwise: add release notes to the automatically created release.

### Publish

### Publish to npm

In the `package` directory do
To publish:

```
make publish
```

(This requires your npm user to have publishing privileges for the package on npm.)


### Copy over to AutobahnJSbuilt

Just copy over the contents of the `build` directory to the AutobahnJSbuilt repo, tag and commit.


### Upload to S3

Do

```
scons publish
```

to upload the built version to S3.
Don't forget to tag and push from the AutobahnJSbuilt repo (which has been updated by above command).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "autobahn",
"version": "0.11.1",
"version": "0.11.2",
"description": "An implementation of The Web Application Messaging Protocol (WAMP).",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit b7a1165

Please sign in to comment.