@leverege/build-tools 2.2.5 → 2.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.2.5",
+  "version": "2.2.6",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "scripts": {

package/src/circleate

@@ -90,17 +90,18 @@ jobs:
           source-tag: \$PACKAGE_VERSION
           target-tag: circle-\$NODE_IMAGE-\$CIRCLE_USERNAME
 
-  smoke-test:
-    # smoke test checks for license, security, and linting
-    docker: 
+  install:
+    docker:
       - image: circleci/node:erbium
     steps:
       - checkout
       - restore_cache:
           key: dependency-cache-{{ checksum "package.json" }}
+      
       - run:
           name: Setup @leverege Token
-          command: echo \${NPMRC} > ~/.npmrc
+          command: echo \${NPMRC} > ~/.npmrc.ro
+      
       - run: npm install
 
       - save_cache:
@@ -108,20 +109,44 @@ jobs:
           paths:
             - ./node_modules
 
+      - persist_to_workspace:
+          root: /home/circleci/project
+          paths:
+            - ./node_modules
+
+  security-check:
+    docker:
+      - image: circleci/node:erbium
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
       - run: 
           name: Check for vulnerabilities
           command: npm audit --production --audit-level=moderate
-
+  
+  license-check:
+    docker:
+      - image: circleci/node:erbium
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project    
       - run:
           name: Check for LICENSE and README files
           command: npm run pkglint
 
       - run:
           name: Check for license violations (e.g. GPL)
-          command: |
-            npm install license-checker
-            npm run licenseCheck
+          command: npx license-checker --production --summary --failOn GPL
 
+  lint: 
+    docker:
+      - image: circleci/node:erbium
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project           
       - run: 
           name: Lint and save results
           command: npm run lint-ci
@@ -129,6 +154,20 @@ jobs:
       - store_test_results:
           path: reports
 
+  docs: 
+    docker:
+      - image: circleci/node:erbium
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project  
+      - run: 
+          name: Generate docs
+          command: npx jsdoc -r src -R README.md -d docs 
+      - store_artifacts:
+          path: docs
+          prefix: docs
+
   coverage:
     # coverage runs tests, generates coverage, and saves docs
     environment:
@@ -156,14 +195,8 @@ jobs:
 
     steps:
       - checkout
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-
-      - run:
-          name: Setup @leverege Token
-          command: echo \${NPMRC} > ~/.npmrc
-
-      - run: npm install
+      - attach_workspace:
+          at: ~/project   
 
       # UNCOMMENT IF YOU NEED DECRYPTING SECRETS
       # - run: 
@@ -177,21 +210,11 @@ jobs:
       - run:
           name: Check if coverage meets at least 70%
           command: ./node_modules/.bin/nyc check-coverage --functions 70 --lines 70 --statements 70
-
-      - run: 
-          name: Generate docs
-          command: |
-            npm install jsdoc 
-            npm run docs
-   
+ 
       - store_artifacts:
           path: coverage
           prefix: coverage
-
-      - store_artifacts:
-          path: docs
-          prefix: docs
-
+  
   build:
     # build should make dist image and prepare docker file
     docker:
@@ -199,16 +222,12 @@ jobs:
 
     steps:
       - checkout
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
+      - attach_workspace:
+          at: ~/project 
 
       - run:
           name: Setup @leverege Token
-          command: |
-            echo \${NPMRC} > ~/.npmrc
-            echo \${NPMRC} > ~/.npmrc.ro
-
-      - run: npm install
+          command: echo \${NPMRC} > ~/.npmrc.ro 
 
       - run: 
           name: Determine version number and container name
@@ -225,6 +244,7 @@ jobs:
             echo "export PACKAGE_VERSION=v\${PACKAGE_VERSION}" >> \$BASH_ENV
             echo \${container} > container_name
             echo \${NODE_IMAGE} > node_img
+      
       - run: 
           name: Create Dockerfile and build dist directory
           command: mkdir -p docker && npm run dockerize \$PACKAGE_VERSION
@@ -232,23 +252,32 @@ jobs:
       - persist_to_workspace:
           root: ~/project
           paths:
-            - dist/*
             - docker/*
             - package_version
             - container_name
             - node_img
-            - package*json
 
 workflows:
   version: 2.1
   test-build-deploy:
     jobs:
-      - smoke-test:
+      - install:
           context: npm
+      - security-check:
+          requires:
+            - install
+      - license-check:
+          requires:
+            - install
+      - lint:
+          requires:
+            - install
       - coverage:
-          context: npm 
           requires:
-            - smoke-test
+            - install
+      - docs: 
+          requires:
+            - install
       - build:
           context: npm
           filters:
@@ -258,7 +287,12 @@ workflows:
                 - /release-.*/
                 - master
           requires:
-            - smoke-test
+            - install
+            - security-check
+            - license-check
+            - lint
+            - coverage
+            - docs
       - gcr:
           context: google
           filters:
@@ -268,9 +302,13 @@ workflows:
                 - /release-.*/
                 - master
           requires:
-            - smoke-test
-            - build
+            - install
+            - security-check
+            - license-check
+            - lint
             - coverage
+            - docs
+            - build
 EOCIRCLE
 }
 
@@ -278,17 +316,18 @@ create_lib_config(){
   cat<<EOCIRCLE > config.yml
 version: 2.1
 jobs:
-  smoke-test:
-    # smoke test checks for license, security, and linting
-    docker: 
+  install:
+    docker:
       - image: circleci/node:erbium
     steps:
       - checkout
       - restore_cache:
           key: dependency-cache-{{ checksum "package.json" }}
+      
       - run:
           name: Setup @leverege Token
-          command: echo \${NPMRC} > ~/.npmrc
+          command: echo \${NPMRC} > ~/.npmrc.ro
+      
       - run: npm install
 
       - save_cache:
@@ -296,20 +335,44 @@ jobs:
           paths:
             - ./node_modules
 
+      - persist_to_workspace:
+          root: /home/circleci/project
+          paths:
+            - ./node_modules
+
+  security-check:
+    docker:
+      - image: circleci/node:erbium
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project
       - run: 
           name: Check for vulnerabilities
           command: npm audit --production --audit-level=moderate
-
+  
+  license-check:
+    docker:
+      - image: circleci/node:erbium
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project    
       - run:
           name: Check for LICENSE and README files
           command: npm run pkglint
 
       - run:
           name: Check for license violations (e.g. GPL)
-          command: |
-            npm install license-checker
-            npm run licenseCheck
+          command: npx license-checker --production --summary --failOn GPL
 
+  lint: 
+    docker:
+      - image: circleci/node:erbium
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project           
       - run: 
           name: Lint and save results
           command: npm run lint-ci
@@ -317,8 +380,24 @@ jobs:
       - store_test_results:
           path: reports
 
+  docs: 
+    docker:
+      - image: circleci/node:erbium
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/project  
+      - run: 
+          name: Generate docs
+          command: npx jsdoc -r src -R README.md -d docs 
+      - store_artifacts:
+          path: docs
+          prefix: docs
+
   coverage:
     # coverage runs tests, generates coverage, and saves docs
+    environment:
+      TZ: 'America/New_York'
     docker:
       - image: circleci/node:erbium
       # IF YOU NEED ANY OF THESE, UNCOMMENT TO USE
@@ -342,20 +421,14 @@ jobs:
 
     steps:
       - checkout
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-
-      - run:
-          name: Setup @leverege Token
-          command: echo \${NPMRC} > ~/.npmrc
-
-      - run: npm install
+      - attach_workspace:
+          at: ~/project   
 
       # UNCOMMENT IF YOU NEED DECRYPTING SECRETS
       # - run: 
       #     name: Load secrets
       #     command: npm run decrypt
-      
+
       - run:
           name: Run Tests and Generate Code Coverage
           command: npm run coverage
@@ -363,42 +436,32 @@ jobs:
       - run:
           name: Check if coverage meets at least 70%
           command: ./node_modules/.bin/nyc check-coverage --functions 70 --lines 70 --statements 70
-
-      - run: 
-          name: Generate docs
-          command: |
-            npm install jsdoc 
-            npm run docs
-   
+ 
       - store_artifacts:
           path: coverage
           prefix: coverage
 
-      - store_artifacts:
-          path: docs
-          prefix: docs
-
-  # publish:
-  #  # publish the package to npm registry - CURRENTLY DISABLED
-
 workflows:
   version: 2.1
   test-build-deploy:
     jobs:
-      - smoke-test:
+      - install:
           context: npm
+      - security-check:
+          requires:
+            - install
+      - license-check:
+          requires:
+            - install
+      - lint:
+          requires:
+            - install
       - coverage:
-          context: npm 
           requires:
-            - smoke-test
-      # - publish:
-      #     context: npm
-      #     filters:
-      #       branches:
-      #         only: master
-      #     requires:
-      #       - smoke-test
-      #       - coverage
+            - install
+      - docs: 
+          requires:
+            - install
 EOCIRCLE
 }