Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
b366318
[poc] add documentation and related tests
benoitvidis May 28, 2019
6a89673
fix doc compose command
benoitvidis May 28, 2019
d4c1900
add missing -f compose option
benoitvidis May 28, 2019
907de19
fix bulk import test
benoitvidis May 29, 2019
7ed78e6
[doctest] remove non-existing work_dir
benoitvidis May 29, 2019
77ba015
[doctest] split compose btw sdk & doc tests
benoitvidis May 29, 2019
9165a4a
[doctest] fix compose path for doc tests
benoitvidis May 29, 2019
cc67b24
Renamed directory to follow convention
xbill82 Jun 6, 2019
999491d
[move] Received v5 doc from main repo
xbill82 Jun 12, 2019
460cc3d
Fixed config
xbill82 Jun 13, 2019
c45c302
[content] move doc V5 to branch 5-dev
xbill82 Jun 13, 2019
2c052ff
add getting-started folder
berthieresteban Jun 26, 2019
429c8c7
[doc] Updated v6 doc content
xbill82 Jun 27, 2019
ebedc20
[fix] Test cases and Docker Compose
xbill82 Jun 27, 2019
fa180fc
Merge branch '6-dev' into poc-documentation-v6
xbill82 Jun 28, 2019
b94db37
[skip ci] Added npm run doc-testing
xbill82 Jun 28, 2019
03e4c3c
[skip ci] improved npm doc-testing cmd
xbill82 Jun 28, 2019
548604d
[package] fixed doc-testing cmd
xbill82 Jun 28, 2019
aa71e97
[test] fixed dependencies in web runner
xbill82 Jun 28, 2019
eb52b44
Documentation v6 and Snippet Tests (#399)
benoitvidis Jun 28, 2019
f51e64b
fix link
Aschen Jul 1, 2019
5867e92
[fix] Broken link
xbill82 Jul 1, 2019
f44bb6b
Merge branch '6-dev' of https://github.com/kuzzleio/sdk-javascript in…
xbill82 Jul 1, 2019
9924fab
Add-getting-started-vuejs-without-vuex (#405)
berthieresteban Jul 1, 2019
35b1532
make createUser id parameter optional (#408)
jenow Jul 1, 2019
9e27afa
Merge remote-tracking branch 'origin/poc-documentation-v6' into 6-dev
xbill82 Jul 1, 2019
438cd4b
Add-readme-to-vuejs-getting-started (#406)
berthieresteban Jul 1, 2019
eee38f0
add changes of pr 405
berthieresteban Jul 1, 2019
47abd26
Merge pull request #410 from kuzzleio/correct-last-pr
berthieresteban Jul 1, 2019
5295aa8
Release 6.1.4
Aschen Jul 1, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
47 changes: 47 additions & 0 deletions .ci/doc/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---

snippets:
mount: /mnt
path: doc/**/snippets/*.test.yml
templates: /mnt/.ci/doc/templates

runners:
default: node

node:
service: doc-runner-node
path: /var/snippets/node
lint:
global: true
cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }}
before: timeout -t 600 ash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done'
run:
cmd: node {{ snippet.source }}
before: timeout -t 600 ash -c 'until stat /tmp/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done'

web:
service: doc-runner-web
path: /var/snippets/web
lint:
global: true
cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }}/*.html
before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done'
run:
cmd: node puppeteer.js {{ snippet.dir }}/{{ snippet.source }}
before: timeout 600 bash -c 'until stat /tmp/runner_is_ready && curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done'

webpack:
service: doc-runner-webpack
path: /var/snippets/webpack
lint:
global: true
cmd: eslint -c /mnt/.ci/doc/eslint.json {{ snippet.dir }}
before: timeout 600 bash -c 'until stat /tmp/runner_ready_to_lint; do sleep 1; done'
build:
cmd: node webpackBuild.js {{ snippet.dir }}/{{ snippet.source }}
before: timeout 600 bash -c 'until stat /tmp/runner_is_ready; do sleep 1; done'
run:
cmd: node puppeteer.js /tmp/{{ snippet.name }}/index.html
before: timeout 600 bash -c 'until curl -f -s -o /dev/null http://kuzzle:7512/_now; do sleep 1; done'


138 changes: 138 additions & 0 deletions .ci/doc/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
version: '3'

services:
kuzzle:
image: kuzzleio/kuzzle
ports:
- '7512:7512'
cap_add:
- SYS_PTRACE
depends_on:
- redis
- elasticsearch
container_name: kuzzle
environment:
- kuzzle_services__db__client__host=http://elasticsearch:9200
- kuzzle_services__internalCache__node__host=redis
- kuzzle_services__memoryStorage__node__host=redis
- NODE_ENV=production

redis:
image: redis:3.2

elasticsearch:
image: kuzzleio/elasticsearch:5.6.10
ulimits:
nofile: 65536
environment:
- cluster.name=kuzzle
- 'ES_JAVA_OPTS=-Xms256m -Xmx256m'

doc-tests:
image: kuzzleio/snippets-tests
privileged: true
ports:
- '9229:9229'
depends_on:
- kuzzle
- doc-runner-node
- doc-runner-web
- doc-runner-webpack
volumes:
- ../..:/mnt
- /var/run/docker.sock:/var/run/docker.sock
- snippets:/var/snippets
environment:
- CONFIG_FILE=/mnt/.ci/doc/config.yml

doc-runner-node:
image: node:10-alpine
volumes:
- ../..:/mnt
- snippets:/var/snippets
command: >
ash -c '
mkdir -p /var/snippets/node;
apk add --no-cache curl;
npm install -g eslint;
cd /var/snippets/node;
npm install \
bluebird \
/mnt/ \
eslint \
eslint-plugin-html \
eslint-plugin-import \
eslint-plugin-node \
eslint-plugin-promise \
eslint-plugin-standard;
touch /tmp/runner_ready_to_lint;
touch /tmp/runner_is_ready;
tail -f /dev/null
'

doc-runner-web:
image: buildkite/puppeteer:latest
command: >
bash -c '
mkdir -p /var/snippets/web;
apt-get update;
apt-get install -y curl;
npm install -g \
eslint;
cd /mnt;
npm install;
cd /var/snippets/web;
cp /mnt/.ci/doc/puppeteer.js /var/snippets/web/;
npm install \
/mnt/ \
puppeteer \
eslint \
eslint-plugin-html \
eslint-plugin-import \
eslint-plugin-node \
eslint-plugin-promise \
eslint-plugin-standard;
touch /tmp/runner_ready_to_lint;
touch /tmp/runner_is_ready;
tail -f /dev/null
'
volumes:
- ../..:/mnt
- snippets:/var/snippets

doc-runner-webpack:
image: buildkite/puppeteer:latest
command: >
bash -c '
mkdir -p /var/snippets/webpack;
apt-get update;
apt-get install -y curl;
npm install -g \
eslint;
cd /var/snippets/webpack;
cp /mnt/.ci/doc/puppeteer.js /var/snippets/webpack/;
cp /mnt/.ci/doc/webpackBuild.js /var/snippets/webpack/;
npm install \
/mnt/ \
babel-loader \
@babel/core \
puppeteer \
html-webpack-plugin \
webpack \
webpack-cli \
eslint \
eslint-plugin-html \
eslint-plugin-import \
eslint-plugin-node \
eslint-plugin-promise \
eslint-plugin-standard;
touch /tmp/runner_ready_to_lint;
touch /tmp/runner_is_ready;
tail -f /dev/null
'
volumes:
- ../..:/mnt
- snippets:/var/snippets

volumes:
snippets:
Loading