Merge pull request #1362 from sasjs/docs-generation

Docs generation

.github/PULL_REQUEST_TEMPLATE.md

@@ -16,5 +16,6 @@ What code changes have been made to achieve the intent.
 - [ ] Any new functionality has been unit tested.
 - [ ] All unit tests are passing (`npm test`).
 - [ ] All CI checks are green.
-- [ ] JSDoc comments have been added or updated.
+- [ ] Development comments have been added or updated.
+- [ ] Development documentation coverage has been increased and new threshold is set.
 - [ ] Reviewer is assigned.

.github/workflows/run-tests.yml

@@ -16,32 +16,12 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
           cache: npm
-      - name: Install Doxygen
-        run: sudo apt-get install doxygen
-
-      - name: install pm2 for process management
-        run: npm i -g pm2
-
-      - name: Create .env file for sasjs/server
-        run: |
-          touch .env
-          echo RUN_TIMES=js >> .env
-          echo NODE_PATH=node >> .env
-          echo MOCK_SERVERTYPE=sas9 >> .env
-
-      - name: download sasjs/server package from github using curl
-        run: curl -L https://github.com/sasjs/server/releases/latest/download/linux.zip > linux.zip
-
-      - name: unzip downloaded package
-        run: unzip linux.zip
-
-      - name: run sasjs server
-        run: pm2 start api-linux
 
       - name: Check npm audit
         run: npm audit --production --audit-level=low
@@ -54,6 +34,9 @@ jobs:
           npm config set registry http://registry.npmjs.org
           npm ci
 
+      - name: Generate development documentation and test level of documentation coverage
+        run: npm run doc
+
       - name: Check code style
         run: npm run lint
 
@@ -66,12 +49,34 @@ jobs:
       - name: Run smoke tests
         run: sh ./test.sh
 
+      - name: Install Doxygen
+        run: sudo apt-get install doxygen
+
       # Mocked (*.spec.ts) tests will be conducted during this step
       - name: Generate coverage report
         uses: artiomtr/[email protected]
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: install pm2 for process management
+        run: npm i -g pm2
+
+      - name: Create .env file for sasjs/server
+        run: |
+          touch .env
+          echo RUN_TIMES=js >> .env
+          echo NODE_PATH=node >> .env
+          echo MOCK_SERVERTYPE=sas9 >> .env
+
+      - name: download sasjs/server package from github using curl
+        run: curl -L https://github.com/sasjs/server/releases/latest/download/linux.zip > linux.zip
+
+      - name: unzip downloaded package
+        run: unzip linux.zip
+
+      - name: run sasjs server
+        run: pm2 start api-linux
+
       - name: Deploy SAS9 tests
         run: |
           cd mocks

.gitignore

@@ -6,4 +6,5 @@ sasjsbuild
 .env
 .env.*
 .DS_Store
-/coverage
+/coverage
+/documentation