Docker compose nodejs example (#49)

* Added our very first realworld example. Docker-compose nodejs up

Author: firecow

README.md

@@ -11,30 +11,32 @@ Tired of pushing commits to test your .gitlab-ci.yml?
 
 Then this is the tool for you.
 
-Run gitlab pipelines on your local machine as shell runner or docker executor.
+Run gitlab pipelines on your local machine as shell executor or docker executor.
 
 Get rid of all those pesky dev workflow shell scripts and make files.
 
 ## Table of contents
 * [Introduction](#introduction)
 * [Table of contents](#table-of-contents)
+* [Examples](#examples)
 * [Installation](#installation)
     * [NPM](#npm)
     * [Linux](#linux)
     * [Windows (Git bash)](#windows-git-bash)
     * [Macos](#macos)
-* [Usage](#usage)
-    * [Example](#example)
-    * [Convinience](#convinience)
-        * [Bash alias](#bash-alias)
-        * [Bash completion](#bash-completion)
-    * [Quirks](#quirks)
-        * [Artifacts](#artifacts)
+* [Convinience](#convinience)
+    * [Bash alias](#bash-alias)
+    * [Bash completion](#bash-completion)
+* [Quirks](#quirks)
+    * [Artifacts](#artifacts)
 * [Development](#development)
     * [Scripts](#scripts)
     * [Package binaries](#package-binaries)
     * [Will not be implemented](#will-not-be-implemented)
 
+## Examples
+- [Docker Compose "deploy" a nodejs webserver](examples/docker-compose-nodejs/README.md)
+
 ## Installation
 ### NPM
 ```
@@ -70,45 +72,13 @@ chmod +x /usr/local/bin/gitlab-ci-local
 exit
 ```
 
-## Usage
-### Example
-
-```
-# /home/user/workspace/myproject/.gitlab-ci.yml
----
-stages: [ build, .post ]
-
-# @Description Is only executed locally
-clean:
-  stage: .post
-  rules:
-    - { if: $GITLAB_CI == 'false' }
-  script:
-    - echo "I'm only executed locally because GITLAB_CI is false via gitlab-ci-local"
-    - echo "I also have a description, when gitlab-ci-local --list is executed"
-
-# @Description Is only executed remotely
-build:
-  stage: build
-  tags: [ runner-tag ]
-  rules:
-    - { if: $GITLAB_CI == 'true' }
-  script:
-    - echo "I'm only executed remotely because GITLAB_CI is true on actual gitlab runners"
-    
-
-
-cd /home/user/workspace/myproject
-gitlab-ci-local
-```
-
-### Convinience
-#### Bash alias
+## Convinience
+### Bash alias
 ```
 echo "alias gcl='gitlab-ci-local'" >> ~/.bashrc
 ```
 
-#### Bash completion
+### Bash completion
 
 Add this to `~/.bashrc`
 ```
@@ -134,19 +104,21 @@ _yargs_completions()
 complete -o default -F _yargs_completions gitlab-ci-local
 ```
 
-### Quirks
-#### Artifacts
-Artifacts works right now, as along as you don't overwrite tracked files.
+## Quirks
+### Artifacts
+Shell executor just place files in host directory
+
+Docker executor copies files specified via artifacts field to host
 
 ## Development
 ### Scripts
 ```
 npm install
 npm run build
-npm start -- --cwd /home/user/workspace/project-folder/
+npm start
 ```
 
-![output](docs/images/development.png)
+![output](docs/images/example.png)
 
 ### Package binaries
 ```
@@ -160,10 +132,9 @@ npm run pkg-all
 - pages
 - resource_group
 - interruptible
-- only
-- except
+- only (deprecated)
+- except (deprecated)
 - parallel
 - trigger
 - retry (in case of failure)
 - timeout (job max execution time)
-- coverage (code coverage)

docs/images/development.png

@@ -0,0 +1,2 @@
+.gitlab-ci-local/
+node_modules/

docs/images/example.png

@@ -0,0 +1,36 @@
+
+# @Description Install npm packages
+npm-install:
+  stage: .pre
+  image: node
+  artifacts:
+    paths:
+      - node_modules/
+  script:
+    - npm install --no-audit
+
+# @Description Find security vulnerabilities in node_modules
+npm-audit:
+  stage: test
+  image: node
+  needs: [ ]
+  allow_failure: true
+  script: npm audit
+
+# @Description Find outdated packages in node_modules
+npm-outdated:
+  stage: test
+  image: node
+  needs: [ npm-install ]
+  allow_failure: true
+  script:
+    - npx -s ncu -e2 --deprecated
+
+# @Description Up docker-compose services
+docker-compose-up:
+  stage: deploy
+  environment:
+    url: http://localhost:8891
+    name: local
+  script:
+    - docker-compose --no-ansi up -d

examples/docker-compose-nodejs/.gitignore

@@ -0,0 +1,12 @@
+# docker-compose nodejs example
+
+- Install npm packages
+  - Copy those packages to host and child jobs, because of the artifacts fields (npm-install) 
+- Check for security vulnerbilities in npm packages (npm-audit)
+- Check for outdated packages via npm-check-updates package (npm-outdated)
+- Deploy a webserver container via docker-compose (docker-compose-up)
+
+
+```
+gitlab-ci-local --cwd examples/docker-compose-nodejs/
+```

examples/docker-compose-nodejs/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+services:
+  webserver:
+    image: node
+    command: node webserver.js
+    ports:
+      - 8891:3000
+    volumes:
+      - ./node_modules/:/node_modules/
+      - ./webserver.js:/webserver.js