ddsl 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbf0d40e7957eb4db36772b305282892b5084f2c
-  data.tar.gz: 447843b863036959416cb10ab4ced57da3fd70c2
+  metadata.gz: 876daff17fe025456c007e7a6b49aeaefe308694
+  data.tar.gz: c7724c6cfd1088081d87febf8420283feb0a6c3d
 SHA512:
-  metadata.gz: e879a19bda67f10c326dd8155f3637c7630e8bb05a8728bd27d931878bcd0eb7aff0480d688b5c11ad4e883bc01ecd2b3dd1c8f4f861e63af8c81ad89d7a3a5e
-  data.tar.gz: 4296bae73cb2db3525c66e591c315b09685f78aec50234c8ba6db06db2bd567d59fd9ec311b7e5fb6a189a2344eb6b0d170e5be706e14b41b7d135406ded7673
+  metadata.gz: c69636d47110c9d3cb5fc38ca0e5670f7012a8f58bf8b03777ee1670e844ffbaf81e8fd77802c579a95c1874a365211303c110eb295675a775b5878e0690f208
+  data.tar.gz: f274b265cd533d9e5474b829cb1be93b9c1d103249351c4d0e148241a08250c9794564685d7e524db0a2f33fc24f1d3ce93a4aeada63dcfed07d9e245a550229

data/.ddsl.yml

@@ -16,6 +16,7 @@ builds:
     push: true
     cache_from:
       - bilby91/ddsl:latest
+
   - name: master-branch
     type: docker
     context: .
@@ -26,29 +27,76 @@ builds:
     push: true
     cache_from:
       - bilby91/ddsl:latest
+
   - name: dev
     type: docker-compose
     file: docker/docker-compose.yml
 
+  - name: docs-builder
+    type: docker
+    file: docker/jsonschema2md/Dockerfile
+    context: docker/jsonschema2md
+    push: true
+    tags:
+      - bilby91/jsonschema2md:latest
+
+  - name: changelog-builder
+    type: docker
+    file: docker/github_changelog_generator/Dockerfile
+    context: docker/github_changelog_generator
+    push: true
+    tags:
+      - bilby91/github_changelog_generator:latest
+
 runs:
   - name: bash
     type: docker-compose
     file: docker/docker-compose.yml
     service: ddsl
     cmd: /bin/bash
+
   - name: test-ci
     type: docker
     image: bilby91/ddsl:$CI_SHA1
     cmd: bundle exec rspec spec
+
   - name: lint-ci
     type: docker
     image: bilby91/ddsl:$CI_SHA1
     cmd: rubocop .
+
   - name: test
     type: docker
     image: bilby91/ddsl:latest
     cmd: bundle exec rspec spec
+
   - name: lint
     type: docker
     image: bilby91/ddsl:latest
-    cmd: rubocop .
+    cmd: rubocop .
+
+  - name: build-docs
+    type: docker
+    image: bilby91/jsonschema2md
+    rm: true
+    cmd: jsonschema2md --input /schemas --out /docs --draft 06 -n
+    volumes:
+      - $PWD/schemas:/schemas
+      - $PWD/docs:/docs
+
+  - name: build-changelog
+    type: docker
+    image: bilby91/github_changelog_generator:latest
+    rm: true
+    cmd: github_changelog_generator -u bilby91 -p ddsl
+    envs:
+      CHANGELOG_GITHUB_TOKEN: $CHANGELOG_GITHUB_TOKEN
+    volumes:
+      - $PWD:/app
+
+  - name: publish
+    type: docker
+    image: bilby91/ddsl:$CI_SHA1
+    cmd: scripts/publish.sh
+    envs:
+      RUBYGEMS_TOKEN: $RUBYGEMS_TOKEN

data/.gitlab-ci.yml

@@ -9,6 +9,7 @@ services:
 stages:
   - build
   - checks
+  - publish
 before_script:
   - export CI_SHA1=gitlab-$CI_COMMIT_SHA
 build:
@@ -30,4 +31,10 @@ test:
 lint:
   stage: checks
   script:
-    - ddsl run lint-ci
+    - ddsl run lint-ci
+publish:
+  stage: publish
+  script:
+    - ddsl run publish
+  only:
+    - /v[0-9]+(\.[0-9]+)*/

data/.travis.yml

@@ -7,7 +7,7 @@ services:
 
 env:
   global:
-    - DDSL_VERSION=0.0.3
+    - DDSL_VERSION=0.0.4
     - DOCKER_COMPOSE_VERSION=1.23.1
 
 stages:

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Change Log
+
+## [v0.0.4](https://github.com/bilby91/ddsl/tree/v0.0.4) (2018-12-08)
+[Full Changelog](https://github.com/bilby91/ddsl/compare/v0.0.3...v0.0.4)
+
+**Closed issues:**
+
+- Add docs for schema [\#4](https://github.com/bilby91/ddsl/issues/4)
+
+**Merged pull requests:**
+
+- Fix volumes schema definition for run command [\#9](https://github.com/bilby91/ddsl/pull/9) ([bilby91](https://github.com/bilby91))
+- Add docs [\#7](https://github.com/bilby91/ddsl/pull/7) ([bilby91](https://github.com/bilby91))
+- Use registries [\#6](https://github.com/bilby91/ddsl/pull/6) ([bilby91](https://github.com/bilby91))
+- Add docker registries [\#3](https://github.com/bilby91/ddsl/pull/3) ([bilby91](https://github.com/bilby91))
+
+## [v0.0.3](https://github.com/bilby91/ddsl/tree/v0.0.3) (2018-12-04)
+[Full Changelog](https://github.com/bilby91/ddsl/compare/v0.0.2...v0.0.3)
+
+**Merged pull requests:**
+
+- Add pull option for build [\#2](https://github.com/bilby91/ddsl/pull/2) ([bilby91](https://github.com/bilby91))
+- Add CI inception [\#1](https://github.com/bilby91/ddsl/pull/1) ([bilby91](https://github.com/bilby91))
+
+## [v0.0.2](https://github.com/bilby91/ddsl/tree/v0.0.2) (2018-11-30)
+[Full Changelog](https://github.com/bilby91/ddsl/compare/v0.0.1...v0.0.2)
+
+## [v0.0.1](https://github.com/bilby91/ddsl/tree/v0.0.1) (2018-11-23)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -1,9 +1,29 @@
 # ddsl
 
-Docker Declarative Specific Language
+> Docker Declarative Specific Language
 
 `ddsl` allow developers to express in a declarative way how application are built, run and tested. Building, running and testing applications should be semlessly, independently on what environment your are. `ddsl` makes the latter easy by providing one cli to use in CI and development environments.
 
+## Dependencies
+
+- ruby
+- docker
+- docker-compose
+
+## Installation
+
+You can install `ddsl` with either of this mechansims
+
+### Gem
+
+Like any ruby gem
+
+`gem install ddsl`
+
+### Docker
+
+When running on modern CI providers like [Circle CI](https://circleci.com) or [GitLab](https://gitlab.com) you can install it using the docker image `bilby91/ddsl:latest`. You can find more information on how to use it by looking at ddsl's [Circle CI implementation](https://github.com/bilby91/ddsl/blob/master/.circleci/config.yml) or [GitLab implementation](https://github.com/bilby91/ddsl/blob/master/.gitlab-ci.yml)
+
 ## Usage
 
 `ddsl` it's a command line tool that works with a companion `.ddsl.yml` file. In the `.ddsl.yml` file you can declare the diferent builds and runs that your application will need. A very simple example would look like this:
@@ -21,77 +41,57 @@ builds:
     push: true
     cache_from:
       - bilby91/ddsl:latest
-  - name: master-branch
-    type: docker
-    context: .
-    file: docker/Dockerfile
-    tags:
-      - bilby91/ddsl:$CI_SHA1
-      - bilby91/ddsl:latest
-    push: true
-    cache_from:
-      - bilby91/ddsl:latest
-  - name: dev
-    type: docker-compose
-    file: docker/docker-compose.yml
 
 runs:
-  - name: bash
-    type: docker-compose
-    file: docker/docker-compose.yml
-    service: ddsl
-    cmd: /bin/bash
-  - name: test-ci
-    type: docker
-    image: bilby91/ddsl:$CI_SHA1
-    cmd: bundle exec rspec spec
   - name: test
-    type: docker
-    image: bilby91/ddsl:latest
-    cmd: bundle exec rspec spec
-  - name: lint-ci
     type: docker
     image: bilby91/ddsl:$CI_SHA1
-    cmd: rubocop .
+    cmd: bundle exec rspec spec
+
   - name: lint
     type: docker
-    image: bilby91/ddsl:latest
+    image: bilby91/ddsl:$CI_SHA1
     cmd: rubocop .
 ```
 
-In order to run the `feature-branch` build for example, you would need to invoke the `ddsl` like this:
+### Build
 
-`ddsl build feature-branch`
+In order to run our feature-branch build we invoke
 
-Or maybe you want to run you tests
+`ddsl build feature-branch`
 
-`ddsl run test`
+### Run
 
-Or maybe you want to run your tests and also lint your code
+Now that we have our image built we can run things on it
 
 `ddsl run test lint`
 
+### Environment Variables
+
+- [ ] TODO
+
 ## Documentation
 
-The best documentation at this moment is looking at the source code of the project. `ddsl` uses itself to run in CI and developers use it to run in their development environments. Take a look at `.ddsl.yml` file in the root of the repository for more information.
+For the moment, looking at how `ddsl` uses itself is the best documentation. You can find it here [`.ddsl.yml`](https://github.com/bilby91/ddsl/blob/master/.ddsl.yml).
+
+You can also look at how `ddsl` integrates with different CI providers
+
+- [Circle CI](https://github.com/bilby91/ddsl/blob/master/.circleci/config.yml) 
+- [GitLab](https://github.com/bilby91/ddsl/blob/master/.gitlab-ci.yml)
+- [Travis](https://github.com/bilby91/ddsl/blob/master/.travis.yml)
 
-Full documentation of the schema can be found here https://github.com/bilby91/ddsl/blob/master/docs/ddsl.schema.md
+### Schema
 
-## Contnious Integration
+The `.ddsl.yml` schema [documentation](https://github.com/bilby91/ddsl/blob/master/docs/ddsl.schema.md) can found [here](https://github.com/bilby91/ddsl/blob/master/docs/ddsl.schema.md) 
+
+## Continuous Integration
 
 | Provider  | Status                                                                                                                                   |
 |-----------|------------------------------------------------------------------------------------------------------------------------------------------|
 | GitLab CI | [![Gitlab CI](https://img.shields.io/gitlab/pipeline/bilby91/ddsl/master.svg)](https://gitlab.com/bilby91/ddsl)                          |
 | Circle CI | [![Circle CI](https://img.shields.io/circleci/project/github/bilby91/ddsl/master.svg)](https://circleci.com/gh/bilby91/ddsl/tree/master) |
 | Travis CI | [![Travis CI](https://img.shields.io/travis/com/bilby91/ddsl/master.svg)](https://travis-ci.com/bilby91/ddsl)                                |
-
-## Dependencies
-
-- ruby
-- docker
-- docker-compose
-
 ## Contact
 
 - Martín Fernández <fmartin91@gmail.com>
-- Iván Etchart <ivan.etchart@me.com>
+- Iván Etchart <ivan.etchart@me.com>

data/docker/Dockerfile

@@ -42,5 +42,4 @@ COPY . $APP_HOME
 RUN gem build ddsl.gemspec
 
 # Install binary
-# FIXME: We need to load the version dynamically
-RUN gem install --no-rdoc --no-ri --local ddsl-0.0.4.gem
+RUN gem install --no-rdoc --no-ri --local ddsl-$(scripts/version.sh).gem

data/docker/github_changelog_generator/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:latest
+
+# Install github_changelog_generator
+RUN gem install github_changelog_generator
+
+WORKDIR /app

data/docker/jsonschema2md/Dockerfile

@@ -0,0 +1,4 @@
+FROM node:latest
+
+# Install jsonschema2md
+RUN npm install --global @adobe/jsonschema2md

data/docs/ddsl.schema.json

@@ -19,7 +19,7 @@
         "registries": {
             "type": "array",
             "items": {
-                "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/testing/docs/registry.schema.json"
+                "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/master/docs/registry.schema.json"
             },
             "default": [],
             "description": "List of registries to authenticate when performing either a build or run operation"
@@ -27,14 +27,14 @@
         "builds": {
             "type": "array",
             "items": {
-                "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/testing/docs/build.schema.json"
+                "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json"
             },
             "description": "List of build tasks to run"
         },
         "runs": {
             "type": "array",
             "items": {
-                "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/testing/docs/run.schema.json"
+                "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/master/docs/run.schema.json"
             },
             "description": "List of run tasks to run"
         }

data/docs/ddsl.schema.md

@@ -15,9 +15,9 @@ Schema for the DDSL file format.
 
 | Property | Type | Required | Default | Defined by |
 |----------|------|----------|---------|------------|
-| [builds](#builds) | reference | Optional |  | DDSL (this schema) |
-| [registries](#registries) | reference | Optional | `[]` | DDSL (this schema) |
-| [runs](#runs) | reference | Optional |  | DDSL (this schema) |
+| [builds](#builds) | Build | Optional |  | DDSL (this schema) |
+| [registries](#registries) | Registry | Optional | `[]` | DDSL (this schema) |
+| [runs](#runs) | Run | Optional |  | DDSL (this schema) |
 | [version](#version) | `enum` | **Required** |  | DDSL (this schema) |
 
 ## builds
@@ -27,16 +27,16 @@ List of build tasks to run
 `builds`
 
 * is optional
-* type: reference
+* type: Build
 * defined in this schema
 
 ### builds Type
 
 
-Array type: reference
+Array type: Build
 
 All items must be of the type:
-* []() – `https://raw.githubusercontent.com/bilby91/ddsl/testing/docs/build.schema.json`
+* [Build](build.schema.md) – `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json`
 
 
 
@@ -52,7 +52,7 @@ List of registries to authenticate when performing either a build or run operati
 `registries`
 
 * is optional
-* type: reference
+* type: Registry
 
 * default: `[]`
 * defined in this schema
@@ -60,10 +60,10 @@ List of registries to authenticate when performing either a build or run operati
 ### registries Type
 
 
-Array type: reference
+Array type: Registry
 
 All items must be of the type:
-* []() – `https://raw.githubusercontent.com/bilby91/ddsl/testing/docs/registry.schema.json`
+* [Registry](registry.schema.md) – `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/registry.schema.json`
 
 
 
@@ -79,16 +79,16 @@ List of run tasks to run
 `runs`
 
 * is optional
-* type: reference
+* type: Run
 * defined in this schema
 
 ### runs Type
 
 
-Array type: reference
+Array type: Run
 
 All items must be of the type:
-* []() – `https://raw.githubusercontent.com/bilby91/ddsl/testing/docs/run.schema.json`
+* [Run](run.schema.md) – `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/run.schema.json`
 
 
 

data/docs/run.schema.json

@@ -64,8 +64,8 @@
                     "description": "Set environment variables"
                 },
                 "volumes": {
-                    "type": "object",
-                    "additionalProperties": {
+                    "type": "array",
+                    "items": {
                         "type": "string"
                     },
                     "description": "Bind mount volumes"
@@ -130,8 +130,8 @@
                     "description": "Set environment variables"
                 },
                 "volumes": {
-                    "type": "object",
-                    "additionalProperties": {
+                    "type": "array",
+                    "items": {
                         "type": "string"
                     },
                     "description": "Bind mount volumes"

data/docs/run.schema.md

@@ -54,7 +54,7 @@ Unique name to identify the run task.
 | [service_ports](#service_ports) | `string` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/run.schema.json#/definitions/run_docker_compose_options` |
 | [type](#type) | `enum` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/run.schema.json#/definitions/run_docker_compose_options` |
 | [user](#user) | `string` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/run.schema.json#/definitions/run_docker_compose_options` |
-| [volumes](#volumes) | `object` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/run.schema.json#/definitions/run_docker_compose_options` |
+| [volumes](#volumes) | `string[]` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/run.schema.json#/definitions/run_docker_compose_options` |
 | [workdir](#workdir) | `string` | `https://raw.githubusercontent.com/bilby91/ddsl/master/docs/run.schema.json#/definitions/run_docker_compose_options` |
 
 ## cmd
@@ -291,17 +291,20 @@ Bind mount volumes
 `volumes`
 
 * is optional
-* type: `object`
+* type: `string[]`
 * defined in this schema
 
 ### volumes Type
 
 
-`object` with following properties:
+Array type: `string[]`
+
+All items must be of the type:
+`string`
+
+
 
 
-| Property | Type | Required |
-|----------|------|----------|
 
 
 

data/lib/ddsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DDSL
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/schemas/ddsl.schema.json

@@ -19,7 +19,7 @@
     "registries": {
       "type": "array",
       "items": {
-        "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/testing/docs/registry.schema.json"
+        "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/master/docs/registry.schema.json"
       },
       "default": [
 
@@ -29,14 +29,14 @@
     "builds": {
       "type": "array",
       "items": {
-        "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/testing/docs/build.schema.json"
+        "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/master/docs/build.schema.json"
       },
       "description": "List of build tasks to run"
     },
     "runs": {
       "type": "array",
       "items": {
-        "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/testing/docs/run.schema.json"
+        "$ref": "https://raw.githubusercontent.com/bilby91/ddsl/master/docs/run.schema.json"
       },
       "description": "List of run tasks to run"
     }

data/schemas/run.schema.json

@@ -111,7 +111,7 @@
           "description": "Working directory inside the container"
         },
         "service_ports": {
-          "type": "string",
+          "type": "boolean",
           "description": "Run command with the service's ports enabled and mapped to the host"
         },
         "detach": {

data/scripts/publish.sh

@@ -0,0 +1,15 @@
+COMPILED_GEM_PATH=ddsl-$(scripts/version.sh).gem
+
+if [ ! -f $COMPILED_GEM_PATH ]; then
+  echo "Compiled gem not found at $COMPILED_GEM_PATH"
+  exit -1
+fi
+
+# Copy RUBYGEMS_TOKEN to the credentials file
+echo -e "---\n:rubygems_api_key: $RUBYGEMS_TOKEN" > ~/.gem/credentials
+
+# Fix permissions
+chmod 0600 ~/.gem/credentials
+
+# Push current gem version
+gem push $COMPILED_GEM_PATH

data/scripts/version.sh

@@ -0,0 +1 @@
+cat lib/ddsl/version.rb  | grep VERSION | awk '{ print $NF }' | sed -e "s/^'//" -e "s/'$//"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddsl
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Martin Fernandez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-08 00:00:00.000000000 Z
+date: 2019-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -123,6 +123,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -132,6 +133,8 @@ files:
 - docker/Dockerfile
 - docker/Dockerfile.dev
 - docker/docker-compose.yml
+- docker/github_changelog_generator/Dockerfile
+- docker/jsonschema2md/Dockerfile
 - docs/build.schema.json
 - docs/build.schema.md
 - docs/ddsl.schema.json
@@ -163,6 +166,8 @@ files:
 - schemas/ddsl.schema.json
 - schemas/registry.schema.json
 - schemas/run.schema.json
+- scripts/publish.sh
+- scripts/version.sh
 homepage: https://github.com/bilby91/ddsl
 licenses:
 - MIT
@@ -183,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: Docker Declarative Specific Language