Merge pull request #34 from WorldBank-Transport/develop

Release new version of ram-analysis

Author: olafveerman

.circleci/config.yml

@@ -80,13 +80,13 @@ jobs:
           command: docker build -t ram-tools ./ram-tools
 
       - run:
-          name: Build Docker image of ${DOCKER_IMAGE}
+          name: Build Docker image of ram-vt
           command: docker build -t ${DOCKER_IMAGE} ./ram-vt
 
       - run:
           name: Tag and push Docker image for ram-vt's stable version
           command: |
-            # Grab version from package.json and prepend with ram-analysis-v (ram-analysis-v0.5.0)
+            # Grab version from package.json and prepend with ram-vt-v (ram-vt-v0.5.0)
             VERSION=v$(grep -m1 version ram-vt/package.json | awk -F: '{ print $2 }' | sed 's/[", ]//g')
 
             docker login -u $DOCKER_USERNAME -p $DOCKER_PASSWD
@@ -137,11 +137,11 @@ jobs:
           command: docker build -t ram-tools ./ram-tools
 
       - run:
-          name: Build Docker image of ${DOCKER_IMAGE}
+          name: Build Docker image of ram-analysis
           command: docker build -t ${DOCKER_IMAGE} ./ram-analysis
 
       - run:
-          name: Tag and push Docker image for ${DOCKER_IMAGE}'s stable version
+          name: Tag and push Docker image for ram-analysis stable version
           command: |
             # Grab version from package.json and prepend with ram-analysis-v (ram-analysis-v0.5.0)
             VERSION=v$(grep -m1 version ram-analysis/package.json | awk -F: '{ print $2 }' | sed 's/[", ]//g')

README.md

@@ -13,3 +13,14 @@ docker build -t ram-tools .
 cd ram-analysis
 docker build -t ram-analysis .
 ```
+
+## Releasing a new version
+The process to release a new version:
+
+- still on `develop`, bump the version in `./ram-tools/package.json` and/or `./ram-analysis/package.json`
+- set up PR, have somebody do a review and merge `develop` into `master`
+- CircleCI will add a new tag to git using the version in `package.json`  
+Because this repo holds two containers that are independently versioned, the git tags are prepended with the container name (eg. `ram-vt-v0.1.0`)
+- if the tagging was successful, CircleCI will build the Docker image, tag it with the version number and push it to Docker Hub. If the tagging failed (because the version wasn't updated in `package.json`), the build fails
+
+Once this is done, you can [add a new release on Github](https://github.com/WorldBank-Transport/ram-datapipeline/releases/new) with useful notes that describe it.

ram-analysis/app/index.js

@@ -173,7 +173,7 @@ operationExecutor
 .then(() => process.exit(0))
 .catch(err => {
   console.log('err', err);
-  let eGroup = logger.group('error');
+  let eGroup = logger.group('fatal-error');
   if (err.message) {
     eGroup.log(err.message);
     eGroup.log(err.stack);
@@ -183,7 +183,10 @@ operationExecutor
   logger.toFile(`${WORK_DIR}/process.log`);
   operation.log(opCodes.OP_ERROR, {error: err.message || err})
     .then(() => operation.finish())
-    .then(() => process.exit(1), () => process.exit(1));
+    .then(() => process.exit(1))
+    // If it errors again exit.
+    // This is especially important in the case of DB errors.
+    .catch(() => process.exit(1));
 });
 
 //

ram-analysis/app/s3/index.js

@@ -24,7 +24,9 @@ switch (STORAGE_ENGINE) {
     break;
   case 's3':
     minioClient = new Minio.Client({
+      // Endpoint gets updated based on region.
       endPoint: 's3.amazonaws.com',
+      region: STORAGE_REGION,
       accessKey: STORAGE_ACCESS_KEY,
       secretKey: STORAGE_SECRET_KEY
     });

ram-analysis/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ram-analysis",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "",
   "main": "index.js",
   "scripts": {