chore: configures CI to work with a monorepo

apiaryio · Oct 3, 2019 · 9a04883 · 9a04883
1 parent 94dae5a
commit 9a04883
Show file tree

Hide file tree

Showing 40 changed files with 52 additions and 48 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,31 +1,23 @@
 version: 2.1
 
 commands:
-  npm-install:
-    steps:
-      - run: echo $(node --version) > .node-version
-      - restore_cache:
-          key: js-deps-{{ checksum ".node-version" }}-{{ checksum "package.json" }}
-      - run: npm install --no-save
-      - save_cache:
-          key: js-deps-{{ checksum "package.json" }}
-          paths:
-            - ./node_modules
-
   pip-install-docs:
     steps:
       - run: echo $(python --version) > .python-version
       - restore_cache:
-          key: py-deps-{{ checksum ".python-version" }}-{{ checksum "docs/requirements.txt" }}
+          key: py-deps-{{ checksum ".python-version" }}-{{ checksum "./docs/requirements.txt" }}
       - run: 'if [ ! -d ./venv ]; then python -m venv ./venv; fi'
       - run: echo "source $(pwd)/venv/bin/activate" >> $BASH_ENV
       - run: pip install -r ./docs/requirements.txt
       - save_cache:
-          key: py-deps-{{ checksum "docs/requirements.txt" }}
+          key: py-deps-{{ checksum "./docs/requirements.txt" }}
           paths:
             - ./venv
 
 aliases:
+  - &install
+    - run: sudo npm i -g yarn && yarn install --frozen-lockfile
+
   - &node12
     image: circleci/node:12
 
@@ -35,9 +27,9 @@ aliases:
   - &test-steps
     steps:
       - checkout
-      - npm-install
-      - run: npm run build
-      - run: npm run ci:test
+      - <<: *install
+      - run: yarn build
+      - run: yarn ci:test
 
 jobs:
   test-node12:
@@ -56,60 +48,60 @@ jobs:
     docker: [<<: *node12]
     steps:
       - checkout
-      - npm-install
-      - run: npm run build
-      - run: npm run e2e:apib
+      - <<: *install
+      - run: yarn build
+      - run: yarn e2e:apib
 
   test-e2e-openapi2:
     docker: [<<: *node12]
     steps:
       - checkout
-      - npm-install
-      - run: npm run build
-      - run: npm run e2e:openapi2
+      - <<: *install
+      - run: yarn build
+      - run: yarn e2e:openapi2
 
   quality-checks:
     docker: [<<: *python-docs]
     steps:
       - checkout
-      - npm-install
+      - <<: *install
       - pip-install-docs
-      - run: npm run ci:lint
+      - run: yarn ci:lint
 
   format-check:
     docker: [<<: *node12]
     steps:
       - checkout
-      - npm-install
-      - run: npm run prettify:check
+      - <<: *install
+      - run: yarn prettify:check
 
   docs-dry-run:
     # 'dry run', because production build happens directly on the ReadTheDocs
     # infrastructure
     docker: [<<: *python-docs]
     steps:
       - checkout
-      - npm-install
+      - <<: *install
       - pip-install-docs
-      - run: npm run ci:docs
+      - run: yarn ci:docs
 
   smoke-tests:
     docker:
       - <<: *node12
       - image: circleci/mongo:latest
     steps:
       - checkout
-      - npm-install
-      - run: npm run ci:smoke
+      - <<: *install
+      - run: yarn ci:smoke
 
   release:
     # the GH_TOKEN and NPM_TOKEN environment variables are expected to be set
     # in https://circleci.com/gh/apiaryio/dredd/edit#env-vars
     docker: [<<: *node12]
     steps:
       - checkout
-      - npm-install
-      - run: npm run ci:release
+      - <<: *install
+      - run: yarn ci:release
 
 workflows:
   version: 2

diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@ cov.*
 *.log
 .env*
 __pycache__
+/docs/_build
 
 # Regardless the rules above, never ignore following
 !.vscode/launch.json
diff --git a/appveyor.yml b/appveyor.yml
@@ -3,14 +3,16 @@ environment:
 install:
   - ps: Install-Product node 12
   - 'npm -g install npm@6'
+  - 'npm install -g yarn'
   - "set PATH=%APPDATA%\\npm;%PATH%"
-  - 'npm install'
+  - 'yarn install'
 cache:
-  - 'node_modules -> package.json'
-  - "%APPDATA%\\npm-cache -> package.json"
+  - 'node_modules -> yarn.lock'
+  - "%APPDATA%\\npm-cache -> yarn.lock"
 build: off
 test_script:
   - 'node --version'
   - 'npm --version'
-  - 'npm run build'
-  - 'npm test'
+  - 'yarn --version'
+  - 'yarn build'
+  - 'yarn test'
diff --git a/...ges/dredd/docs/_extensions/cli_options.py → docs/_extensions/cli_options.py b/...ges/dredd/docs/_extensions/cli_options.py → docs/_extensions/cli_options.py
diff --git a/packages/dredd/docs/_extensions/ghissue.py → docs/_extensions/ghissue.py b/packages/dredd/docs/_extensions/ghissue.py → docs/_extensions/ghissue.py
diff --git a/...es/dredd/docs/_extensions/ghlink_check.py → docs/_extensions/ghlink_check.py b/...es/dredd/docs/_extensions/ghlink_check.py → docs/_extensions/ghlink_check.py
diff --git a/packages/dredd/docs/_extensions/specs.py → docs/_extensions/specs.py b/packages/dredd/docs/_extensions/specs.py → docs/_extensions/specs.py
diff --git a/packages/dredd/docs/_links.rst → docs/_links.rst b/packages/dredd/docs/_links.rst → docs/_links.rst
diff --git a/packages/dredd/docs/_static/css/dredd.css → docs/_static/css/dredd.css b/packages/dredd/docs/_static/css/dredd.css → docs/_static/css/dredd.css
diff --git a/packages/dredd/docs/_static/images/README.md → docs/_static/images/README.md b/packages/dredd/docs/_static/images/README.md → docs/_static/images/README.md
diff --git a/.../_static/images/apiary-tests-tutorial.png → .../_static/images/apiary-tests-tutorial.png b/.../_static/images/apiary-tests-tutorial.png → .../_static/images/apiary-tests-tutorial.png
diff --git a/...redd/docs/_static/images/apiary-tests.png → docs/_static/images/apiary-tests.png b/...redd/docs/_static/images/apiary-tests.png → docs/_static/images/apiary-tests.png
diff --git a/.../dredd/docs/_static/images/dredd-logo.png → docs/_static/images/dredd-logo.png b/.../dredd/docs/_static/images/dredd-logo.png → docs/_static/images/dredd-logo.png
diff --git a/packages/dredd/docs/_static/images/dredd.png → docs/_static/images/dredd.png b/packages/dredd/docs/_static/images/dredd.png → docs/_static/images/dredd.png
diff --git a/...edd/docs/_static/images/hooks-handler.key → docs/_static/images/hooks-handler.key b/...edd/docs/_static/images/hooks-handler.key → docs/_static/images/hooks-handler.key
diff --git a/...edd/docs/_static/images/hooks-handler.png → docs/_static/images/hooks-handler.png b/...edd/docs/_static/images/hooks-handler.png → docs/_static/images/hooks-handler.png
diff --git a/packages/dredd/docs/conf.py → docs/conf.py b/packages/dredd/docs/conf.py → docs/conf.py
diff --git a/packages/dredd/docs/data-structures.rst → docs/data-structures.rst b/packages/dredd/docs/data-structures.rst → docs/data-structures.rst
diff --git a/packages/dredd/docs/hooks/go.rst → docs/hooks/go.rst b/packages/dredd/docs/hooks/go.rst → docs/hooks/go.rst
diff --git a/packages/dredd/docs/hooks/index.rst → docs/hooks/index.rst b/packages/dredd/docs/hooks/index.rst → docs/hooks/index.rst
@@ -28,12 +28,12 @@ Let's have a description of a blog API, which allows to list all articles, and t
 
    .. group-tab:: API Blueprint
 
-      .. literalinclude:: ../../test/fixtures/blog/apidesc.apib
+      .. literalinclude:: ../../packages/dredd/test/fixtures/blog/apidesc.apib
          :language: apiblueprint
 
    .. group-tab:: OpenAPI 2
 
-      .. literalinclude:: ../../test/fixtures/blog/apidesc.openapi2.yaml
+      .. literalinclude:: ../../packages/dredd/test/fixtures/blog/apidesc.openapi2.yaml
          :language: openapi2
 
 Now let's say the real instance of the API has the POST request protected so it is not possible for everyone to publish new articles. We do not want to hardcode secret tokens in our API description, but we want to get Dredd to pass the auth. This is where the hooks can help.
@@ -52,7 +52,7 @@ Dredd supports :ref:`writing hooks in multiple programming languages <supported-
 
       Let's create a file called ``hooks.js`` with the following content:
 
-      .. literalinclude:: ../../test/fixtures/blog/hooks.apib.js
+      .. literalinclude:: ../../packages/dredd/fixtures/blog/hooks.apib.js
          :language: javascript
 
       As you can see, we're registering the hook function to be executed **before** the HTTP transaction ``Articles > Publish an article``. This path-like identifier is a :ref:`transaction name <transaction-names>`.
@@ -61,7 +61,7 @@ Dredd supports :ref:`writing hooks in multiple programming languages <supported-
 
       Let's create a file called ``hooks.js`` with the following content:
 
-      .. literalinclude:: ../../test/fixtures/blog/hooks.openapi2.js
+      .. literalinclude:: ../../packages/dredd/test/fixtures/blog/hooks.openapi2.js
          :language: javascript
 
       As you can see, we're registering the hook function to be executed **before** the HTTP transaction ``Articles > Publish an article > 201 > application/json``. This path-like identifier is a :ref:`transaction name <transaction-names>`.

diff --git a/packages/dredd/docs/hooks/js.rst → docs/hooks/js.rst b/packages/dredd/docs/hooks/js.rst → docs/hooks/js.rst
diff --git a/packages/dredd/docs/hooks/new-language.rst → docs/hooks/new-language.rst b/packages/dredd/docs/hooks/new-language.rst → docs/hooks/new-language.rst
diff --git a/packages/dredd/docs/hooks/perl.rst → docs/hooks/perl.rst b/packages/dredd/docs/hooks/perl.rst → docs/hooks/perl.rst
diff --git a/packages/dredd/docs/hooks/php.rst → docs/hooks/php.rst b/packages/dredd/docs/hooks/php.rst → docs/hooks/php.rst
diff --git a/packages/dredd/docs/hooks/python.rst → docs/hooks/python.rst b/packages/dredd/docs/hooks/python.rst → docs/hooks/python.rst
diff --git a/packages/dredd/docs/hooks/ruby.rst → docs/hooks/ruby.rst b/packages/dredd/docs/hooks/ruby.rst → docs/hooks/ruby.rst
diff --git a/packages/dredd/docs/hooks/rust.rst → docs/hooks/rust.rst b/packages/dredd/docs/hooks/rust.rst → docs/hooks/rust.rst
diff --git a/packages/dredd/docs/how-it-works.rst → docs/how-it-works.rst b/packages/dredd/docs/how-it-works.rst → docs/how-it-works.rst
diff --git a/packages/dredd/docs/how-to-guides.rst → docs/how-to-guides.rst b/packages/dredd/docs/how-to-guides.rst → docs/how-to-guides.rst
diff --git a/packages/dredd/docs/index.rst → docs/index.rst b/packages/dredd/docs/index.rst → docs/index.rst
diff --git a/packages/dredd/docs/installation.rst → docs/installation.rst b/packages/dredd/docs/installation.rst → docs/installation.rst
diff --git a/packages/dredd/docs/internals.rst → docs/internals.rst b/packages/dredd/docs/internals.rst → docs/internals.rst
diff --git a/packages/dredd/docs/quickstart.rst → docs/quickstart.rst b/packages/dredd/docs/quickstart.rst → docs/quickstart.rst
diff --git a/packages/dredd/docs/redirects.yml → docs/redirects.yml b/packages/dredd/docs/redirects.yml → docs/redirects.yml
diff --git a/packages/dredd/docs/requirements.txt → docs/requirements.txt b/packages/dredd/docs/requirements.txt → docs/requirements.txt
diff --git a/packages/dredd/docs/usage-cli.rst → docs/usage-cli.rst b/packages/dredd/docs/usage-cli.rst → docs/usage-cli.rst
diff --git a/packages/dredd/docs/usage-js.rst → docs/usage-js.rst b/packages/dredd/docs/usage-js.rst → docs/usage-js.rst
diff --git a/package.json b/package.json
@@ -1,5 +1,20 @@
 {
   "private": true,
+  "scripts": {
+    "build": "lerna exec --scope='dredd' yarn build",
+    "prettify:check": "lerna exec --scope='dredd' yarn prettify:check",
+    "docs:lint": "sphinx-build -nW -b linkcheck ./docs ./docs/_build",
+    "docs:test-extensions": "python -m unittest docs/_extensions/*.py --verbose",
+    "docs:build": "sphinx-build -nW -b html ./docs ./docs/_build",
+    "docs:serve": "sphinx-autobuild ./docs ./docs/_build",
+    "e2e:apib": "lerna exec --scope='dredd' yarn e2e:apib",
+    "e2e:openapi2": "lerna exec --scope='dredd' yarn e2e:openapi2",
+    "ci:release": "lerna exec --scope='dredd' yarn ci:release",
+    "ci:docs": "yarn docs:build",
+    "ci:lint": "lerna exec --scope='dredd' yarn ci:lint && yarn docs:lint && yarn docs:test-extensions",
+    "ci:smoke": "lerna exec --scope='dredd' yarn ci:smoke",
+    "ci:test": "lerna exec --scope='dredd' yarn ci:test"
+  },
   "devDependencies": {
     "lerna": "^3.16.4"
   },

diff --git a/packages/dredd/.gitignore b/packages/dredd/.gitignore
@@ -1,3 +1,2 @@
 /build
 /coverage
-/docs/_build
diff --git a/packages/dredd/package.json b/packages/dredd/package.json
@@ -12,10 +12,6 @@
   "scripts": {
     "start": "npm run build -- --watch",
     "build": "tsc --build tsconfig.json",
-    "docs:lint": "sphinx-build -nW -b linkcheck ./docs ./docs/_build",
-    "docs:test-extensions": "python -m unittest docs/_extensions/*.py --verbose",
-    "docs:build": "sphinx-build -nW -b html ./docs ./docs/_build",
-    "docs:serve": "sphinx-autobuild ./docs ./docs/_build",
     "lint": "./scripts/commitlint.sh && eslint . bin/dredd",
     "prettify": "prettier --write lib/**/*.js test/**/*.js",
     "prettify:check": "prettier --check lib/**/*.js test/**/*.js",
@@ -24,8 +20,7 @@
     "e2e": "npm run e2e:apib && npm run e2e:openapi2",
     "e2e:apib": "cucumber-js",
     "e2e:openapi2": "cucumber-js --world-parameters=\"{\\\"apiDescriptionFormat\\\": \\\"application/swagger+yaml\\\"}\"",
-    "ci:lint": "npm run lint && npm run docs:lint && npm run docs:test-extensions",
-    "ci:docs": "npm run docs:build",
+    "ci:lint": "npm run lint",
     "ci:test": "npm test",
     "ci:smoke": "bash ./scripts/smoke.sh",
     "ci:release": "semantic-release && npm dist-tag add \"dredd@$(npm view dredd version)\" stable",