Comparing version
{ | ||
"name": "devlab", | ||
"version": "3.11.1", | ||
"version": "3.12.0", | ||
"description": "Node utility for running containerized tasks", | ||
@@ -34,2 +34,6 @@ "keywords": [ | ||
"lint": "standard --fix --verbose | snazzy", | ||
"build": "npm run build:mac && npm run build:linux && npm run build:windows", | ||
"build:mac": "pkg . -t node6-mac --out-dir=./bin/mac", | ||
"build:linux": "pkg . -t node6-linux --out-dir=./bin/linux", | ||
"build:windows": "pkg . -t node6-win --out-dir=./bin/windows", | ||
"release:patch": "npm test && npm version patch && git push origin master && git push --tags && npm publish", | ||
@@ -57,2 +61,3 @@ "release:minor": "npm test && npm version minor && git push origin master && git push --tags && npm publish", | ||
"nodemon": "^1.11.0", | ||
"pkg": "^3.0.4", | ||
"proxyquire": "^1.7.11", | ||
@@ -59,0 +64,0 @@ "sinon": "^1.17.0", |
[](https://travis-ci.org/TechnologyAdvice/DevLab) | ||
[](https://codecov.io/gh/TechnologyAdvice/DevLab) | ||
**Updgrading from 2.x to 3.x: Please see [Release Notes](https://github.com/TechnologyAdvice/DevLab/releases/tag/v3.0.0)** | ||
# DevLab | ||
@@ -13,3 +11,3 @@ | ||
 | ||
 | ||
@@ -20,2 +18,4 @@ **FAQ: [Why Devlab over Docker-Compose?](#why-devlab-over-docker-compose)** | ||
### NPM | ||
``` | ||
@@ -25,4 +25,12 @@ npm install devlab -g | ||
**Note: DevLab requires Node v.4+ to run.** | ||
**Note: DevLab requires Node v.6+ to run.** | ||
### Binaries | ||
- [Linux](http://devlab.taplatform.net/linux/devlab) | ||
- [MacOSX](http://devlab.taplatform.net/mac/devlab) | ||
- [Windows](http://devlab.taplatform.net/windows/devlab.exe) | ||
--- | ||
*Obvious Note: You need to have [Docker](https://www.docker.com/) installed as well.* | ||
@@ -77,3 +85,3 @@ | ||
The above can then be executed via the `devlab run` (or `lab run`) command from within the same directory as your project and `devlab.yml`. Execution would do the following: | ||
The above can then be executed via the `devlab run` command from within the same directory as your project and `devlab.yml`. Execution would do the following: | ||
@@ -102,3 +110,3 @@ - Pull and start `mongo` with `DB_ROOT_PASSWORD` environment variable and port `27017` exposed | ||
The above would allow you to run `lab <task>` to execute any of the tasks defined. | ||
The above would allow you to run `devlab <task>` to execute any of the tasks defined. | ||
@@ -110,3 +118,3 @@ ### Custom Execution | ||
``` | ||
lab -e "/bin/sh" | ||
devlab -e "/bin/sh" | ||
``` | ||
@@ -170,3 +178,3 @@ | ||
``` | ||
lab lint -d mongo | ||
devlab lint -d mongo | ||
``` | ||
@@ -177,3 +185,3 @@ | ||
``` | ||
lab lint --disable-all | ||
devlab lint --disable-all | ||
``` | ||
@@ -244,6 +252,34 @@ | ||
### Tests | ||
To run tests, fork & clone the repository then run `npm install && npm test`. | ||
### End-to-End Tests | ||
To run end-to-end tests run `npm run e2e`. This works by fully emulating a run inside the `/test/project` directory and executing `/test/system/run.js` with the `/test/system/tests.json` definitions file. | ||
### Testing Builds | ||
To test binary builds: | ||
**1. Build Binary:** | ||
``` | ||
npm run build:linux | ||
``` | ||
**2. Run (Ubuntu) Docker in Docker:** | ||
``` | ||
docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock -v $PWD:/app -w /app ubuntu sh -c "apt-get update && apt-get install docker.io -y && bash" | ||
``` | ||
**3. Create Devlab Alias:** | ||
``` | ||
alias devlab=$PWD/bin/linux/devlab | ||
``` | ||
Once the above steps are completed the `devlab` executable will be avilable. | ||
## Why Devlab Over Docker Compose? | ||
@@ -250,0 +286,0 @@ |
@@ -23,3 +23,4 @@ 'use strict' | ||
checkForUpdates: () => { | ||
updateNotifier({ pkg }).notify() | ||
const notifier = updateNotifier({ pkg }) | ||
if (notifier.update) output.warn(`Update available: ${notifier.update.latest}`) | ||
}, | ||
@@ -26,0 +27,0 @@ /** |
40810
2.5%796
0.13%297
13.79%13
8.33%