Browse Source

Merge branch 't/454'

Internal: Simplified API docs validation process. Closes #454.
Piotrek Koszuliński 8 years ago
parent
commit
6894776374
4 changed files with 6 additions and 5 deletions
  1. 2 2
      .travis.yml
  2. 2 2
      gulpfile.js
  3. 1 0
      package.json
  4. 1 1
      scripts/install-optional-dependencies.sh

+ 2 - 2
.travis.yml

@@ -15,12 +15,12 @@ before_install:
   - export DISPLAY=:99.0
   - sh -e /etc/init.d/xvfb start
 install:
-  - npm install mgit2 lerna @ckeditor/ckeditor5-dev-tests @ckeditor/ckeditor5-dev-docs
+  - npm install mgit2 lerna gulp @ckeditor/ckeditor5-dev-tests @ckeditor/ckeditor5-dev-docs
   - mgit bootstrap --resolver-url-template="https://github.com/\${ path }.git"
   - lerna bootstrap
 script:
   - npm t
-  - gulp docs:api-json --validate-only
+  - gulp docs:api --validate-only
 notifications:
   slack:
     rooms:

+ 2 - 2
gulpfile.js

@@ -46,7 +46,7 @@ gulp.task( 'docs', () => {
 		.then( runUmberto );
 } );
 
-gulp.task( 'docs:api-json', buildApiDocs );
+gulp.task( 'docs:api', buildApiDocs );
 
 function buildApiDocs() {
 	assertIsInstalled( '@ckeditor/ckeditor5-dev-docs' );
@@ -60,7 +60,7 @@ function buildApiDocs() {
 				process.cwd() + '/packages/ckeditor5-*/src/**/*.@(js|jsdoc)',
 				'!' + process.cwd() + '/packages/ckeditor5-*/src/lib/**/*.js'
 			],
-			validationOnly: process.argv[ 3 ] == '--validate-only'
+			validateOnly: process.argv[ 3 ] == '--validate-only'
 		} );
 }
 

+ 1 - 0
package.json

@@ -35,6 +35,7 @@
     "@ckeditor/ckeditor5-widget": "^0.1.1"
   },
   "devDependencies": {
+    "@ckeditor/ckeditor5-dev-docs": "^7.0.0",
     "@ckeditor/ckeditor5-dev-lint": "^3.0.0",
     "@ckeditor/ckeditor5-dev-tests": "^7.3.0",
     "eslint-config-ckeditor5": "^1.0.0",

+ 1 - 1
scripts/install-optional-dependencies.sh

@@ -13,4 +13,4 @@
 
 set -e
 
-npm i @ckeditor/ckeditor5-dev-docs @ckeditor/ckeditor5-dev-env umberto
+npm i @ckeditor/ckeditor5-dev-env umberto