Merge pull request #11 from ExpediaDotCom/improve-release-process

improving the release process for npm module

Author: Kapil Rastogi

.travis.yml

@@ -19,6 +19,7 @@ script:
   - make build
 
 before_deploy:
+  - make prepare_publish
   - cd dist
 
 deploy:

Makefile

@@ -14,6 +14,12 @@ check-node-version:
 .PHONY: build
 build: check-node-version npm_install idl_codegen tslint compile test
 
+.PHONY: prepare_publish
+prepare_publish:
+	node scripts/version.js
+	cp package.json dist/
+	cp README.md dist/
+
 .PHONY: test
 test:
 	./node_modules/mocha/bin/mocha -r ./node_modules/ts-node/register tests/**/*.ts
@@ -22,7 +28,6 @@ test:
 compile:
 	rm -rf ./dist/
 	tsc -p tsconfig.json
-	cp package.json dist/
 
 .PHONY: tslnt
 tslint:

README.md

@@ -23,3 +23,8 @@ make build
 mkdir -p logs && node dist/examples/index.js
 ```
 
+## How to release this library?
+
+We publish using the git tag. The version.js under scripts/ folder verifies if new tag is greater than current published version on npm.
+If it is good, it updates the new version in package.json under dist/ and publish it on npm
+

package.json

@@ -34,6 +34,8 @@
     "mocha": "^2.5.3",
     "ts-node": "^7.0.0",
     "tslint": "^5.0.0",
-    "typescript": "2.9.2"
+    "typescript": "2.9.2",
+    "npm-registry-package-info": "1.0.5",
+    "semver": "^5.5.0"
   }
 }

scripts/version.js

@@ -0,0 +1,30 @@
+const pkginfo = require('npm-registry-package-info');
+const semver = require('semver');
+const fs = require('fs');
+
+
+const moduleName = 'haystack-client';
+
+const opts = {
+    'packages': [
+        moduleName
+    ]
+};
+
+pkginfo(opts, (error, data) => {
+    if (error) {
+        throw error;
+    }
+    const currentVersion = data.data[moduleName]['dist-tags']['latest'];
+    const releaseVersion = process.env.TRAVIS_TAG
+    if (!releaseVersion) {
+        throw new Error('No git tag commit is found, fail to release the "haystack-client" module');
+    }
+    if (semver.lte(releaseVersion, currentVersion)) {
+        throw new Error(`Current haystack-client on npm registry has greater than or equal new release version ${releaseVersion}. Check your git tag version`);
+    }
+    const rawPackageJson = fs.readFileSync('package.json');
+    const packageJson = JSON.parse(rawPackageJson);
+    packageJson.version = releaseVersion;
+    fs.writeFileSync('package.json', JSON.stringify(packageJson, null, ' '));
+});