continued

mr

package to help deploy merge requests project on test environment with docker, and provide a page to view these projects

this package can listen your project, and auto clone source code to deploy in docker for each merge request. When a merge request is closed or merged, this program will remove docker image and container which used by the closed or merged request.

Each time this program run, it will get all merge_requests are opened and try to deploy them.

finally, you can view them on localhost:8099(of course you can set this port)

Install

  npm install test-mr-server

Before use

To use this package with docker-compose or docker build, we hope you provide a configuration file named continued.json in your project to us to know some details about your project like language .etc. Besides, if you had build artifacts before deploy, we hope you can provide a script in your project to us to get these artifacts, otherwise, we would just clone this project and install dependence, build, this process may be very long... Finally, you should open the gitlab or github web hooks to send request for this program to listen to your project. At least, you should open Job events and merge requests.

the continued.json maybe like this

  {
    "artifacts": {
      "fetch": true
    },
    "scripts": {
      "before-build": "./scripts/install.sh",
      "build": "./scripts/build.sh",
      "post-build": "./scripts/post-build.sh"
    },
    "deployment": {
      "env": {
        "NODE_DEBUG": "xxx"
      },
      "compose": {
        "file": "", //  docker-compose file path
        "entry": "" //  docker service name, such as mr-server
      }
    }
  }

Usage

  mr ~/Document/continued.config.json

you can run this program with this command, which means set config file link to ~/Document/continued.config.json, about this .json, like this:

{
  "project": "makeflow/makeflow-web",
  "service": {
    "type": "gitlab",
    "ci": {
      "type": "gitlab"
    },
    "options": {
      "url": "",
      "credentials": {
        "privateToken": "xxx"
      }
    }
  },
  "server": {
    "hostname": "mr.makeflow.io",
    "http": {
      "port": 80,
      "internalPort": 8099  //  8079 is used in service internally
    }
  },
  "branches": {
    "colors": { //  set colors for your branch tag, if your branch named as feature/test, then this branch would be in blue
      "feature": "blue",
      "fix": "red"
    }
  },
  "deployment": {
    "env": {
      "OSS_KEY": "",  //  your environmental variable in docker compose. these key-value would be transferred to docker
      "OSS_SECRET": ""
    }
  },
  "workDir": "./downloaded", //  file path to store downloaded files
  "concurrency": 2,  //  允许的并发数，build和deploy
  "maxPollingTimes": 10,  //  最大轮训次数
  "pollingGap": 60  //  60s
}

And then, this program would run as a resident process, it would output some message on the shell like docker building info, unzip file info, error message .etc.