Merge branch 'master' into update_nyc_exclude_error

Author: emilyrohrbough

.circleci/config.yml

@@ -2,14 +2,14 @@
 version: 2.1
 orbs:
   # https://github.com/cypress-io/circleci-orb
-  cypress: cypress-io/cypress@1.29.0 # used to run e2e tests
-  win: circleci/windows@2 # run a test job on Windows
+  cypress: cypress-io/cypress@3.0.0 # used to run e2e tests
+  win: circleci/windows@5.0.0 # run a test job on Windows
 
 jobs:
   lint:
     description: Checks the code formatting
     docker:
-      - image: cimg/node:16.9.1
+      - image: cimg/node:16.16.0
         environment:
           # we don't need Cypress to check code styl
           CYPRESS_INSTALL_BINARY: '0'
@@ -20,11 +20,70 @@ jobs:
           name: Code style check 🧹
           command: npm run format:check
       - run: npm run check:markdown
+  
+  install_and_persist:
+    executor: cypress/default
+    steps:
+      - cypress/install
+      - run:
+          name: Install deps for test-apps/old-cypress-config
+          command: npm ci
+          working_directory: test-apps/old-cypress-config
+      - run:
+          name: Install deps for test-apps/new-cypress-config
+          command: npm ci
+          working_directory: test-apps/new-cypress-config
+      - run: npm run check:markdown
+      - persist_to_workspace:
+          paths:
+              - .cache/Cypress
+              - project
+          root: ~/
+
+  windows_test:
+    executor:
+      # executor comes from the "windows" orb
+      name: win/default
+      shell: bash.exe
+    steps:
+      - checkout
+      - run:
+          name: Install node 16
+          command: nvm install 16.16.0
+      - run:
+          name: Use node 16
+          command: nvm use 16.16.0
+      - run:
+          name: Install deps for code coverage
+          command: npm ci 
+      - run:
+          name: Install deps for test-apps/old-cypress-config
+          command: npm ci
+          working_directory: test-apps/old-cypress-config   
+      - cypress/run-tests:
+          # no-workspace: true
+          start-command: npm run start:windows --prefix test-apps/old-cypress-config/all-files
+          # wait-on: 'http://localhost:1234'
+          cypress-command: npx cypress run --project test-apps/old-cypress-config/all-files
+          # store screenshots and videos
+          # store_artifacts: true          
+      - run:
+          # make sure the examples captures 100% of code
+          name: Verify Code Coverage
+          command: npm run coverage:verify
+          working_directory: test-apps/old-cypress-config/all-files
+      - run:
+          name: Check code coverage files 📈
+          # we will check the final coverage report
+          # to make sure it only has files we are interested in
+          # because there are files covered at 0 in the report
+          command: npm i -D check-code-coverage && npm run coverage:check-files:windows
+          working_directory: test-apps/old-cypress-config/all-files
 
   publish:
     description: Publishes the new version of the plugin to NPM
     docker:
-      - image: cimg/node:16.9.1
+      - image: cimg/node:16.16.0
     environment:
       # we don't need Cypress to do the release
       CYPRESS_INSTALL_BINARY: '0'
@@ -40,7 +99,7 @@ jobs:
 
   cyrun:
     docker:
-      - image: cypress/base:16.13.2
+      - image: cypress/base:16.18.1
     parameters:
       jobname:
         type: string
@@ -66,13 +125,10 @@ jobs:
 
   test-code-coverage-plugin:
     docker:
-      - image: cypress/base:16.13.2
+      - image: cypress/base:16.18.1
     steps:
       - attach_workspace:
           at: ~/
-      - run:
-          name: Install deps
-          command: npm ci
       - run:
           command: npm run test
       - store_artifacts:
@@ -84,34 +140,19 @@ jobs:
 workflows:
   build:
     jobs:
-      - cypress/install:
-          cache-key: 'cache-{{ arch }}-{{ .Branch }}-{{ checksum "package-lock.json" }}'
-          pre-steps:
-            - run: npm i -g npm@latest
-          post-install:
-            - run:
-                name: Install deps for test-apps/old-cypress-config
-                command: npm ci
-                working_directory: test-apps/old-cypress-config
-            - run:
-                name: Install deps for test-apps/new-cypress-config
-                command: npm ci
-                working_directory: test-apps/new-cypress-config
-          post-steps:
-            - run: npm run check:markdown 
-
+      - install_and_persist
       - lint:
           requires:
-            - cypress/install
+            - install_and_persist
 
       - test-code-coverage-plugin:
           requires:
-            - cypress/install
+            - install_and_persist
 
       - cyrun:
           name: test-<< matrix.jobname>>
           requires:
-            - cypress/install
+            - install_and_persist
           matrix:
             parameters:
               jobname:
@@ -142,54 +183,7 @@ workflows:
                 - new-cypress-config/ts-example
                 - new-cypress-config/unit-tests-js
                 - new-cypress-config/use-webpack
-
-      - cypress/run:
-          name: Windows test
-          executor:
-            # executor comes from the "windows" orb
-            name: win/default
-            shell: bash.exe
-          no-workspace: true
-          start: npm run start:windows --prefix test-apps/old-cypress-config/all-files
-          wait-on: 'http://localhost:1234'
-          command: npx cypress run --project test-apps/old-cypress-config/all-files
-          # store screenshots and videos
-          store_artifacts: true
-          cache-key: 'cache-{{ arch }}-{{ .Branch }}-{{ checksum "package-lock.json" }}'
-          post-checkout:
-            - run:
-                name: Install node 16
-                command: nvm install 16.13.2
-            - run:
-                name: Use node 16
-                command: nvm use 16.13.2
-            - run:
-                name: Install deps for code coverage
-                command: npm ci
-          post-install:
-            - run:
-                name: Install deps for test-apps/old-cypress-config
-                command: npm ci
-                working_directory: test-apps/old-cypress-config            
-          post-steps:
-            # store the created coverage report folder
-            # you can click on it in the CircleCI UI
-            # to see live static HTML site
-            - store_artifacts:
-                path: test-apps/old-cypress-config/all-files/coverage
-            # make sure the examples captures 100% of code
-            - run:
-                name: Verify Code Coverage
-                command: npm run coverage:verify
-                working_directory: test-apps/old-cypress-config/all-files
-            - run:
-                name: Check code coverage files 📈
-                # we will check the final coverage report
-                # to make sure it only has files we are interested in
-                # because there are files covered at 0 in the report
-                command: npm i -D check-code-coverage && npm run coverage:check-files:windows
-                working_directory: test-apps/old-cypress-config/all-files
-
+      - windows_test
       - publish:
           filters:
             branches:
@@ -228,4 +222,4 @@ workflows:
             - test-new-cypress-config/ts-example
             - test-new-cypress-config/unit-tests-js
             - test-new-cypress-config/use-webpack
-            - Windows test
+            - windows_test

.github/workflows/add-to-triage-board.yml

@@ -0,0 +1,12 @@
+name: 'Add issue/PR to Triage Board'
+on:
+  issues:
+    types:
+      - opened
+  pull_request_target:
+    types:
+      - opened
+jobs:
+  add-to-triage-project-board:
+    uses: cypress-io/cypress/.github/workflows/triage_add_to_project.yml@develop
+    secrets: inherit

.github/workflows/snyk_sca_scan.yaml

@@ -1,13 +1,7 @@
 name: Snyk Software Composition Analysis Scan
-# This git workflow leverages Snyk actions to perform a Software Composition 
-# Analysis scan on our Opensource libraries upon Pull Requests to Master & 
-# Develop branches. We use this as a control to prevent vulnerable packages 
-# from being introduced into the codebase. 
 on:
-  pull_request_target:
-    types:
-      - opened
-    branches: 
+  pull_request:
+    branches:
       - master
       - develop
 jobs:
@@ -17,17 +11,15 @@ jobs:
       matrix:
         node-version: [16.x]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Setting up Node
-        uses: actions/setup-node@v1
+        #- name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Installing snyk-delta and dependencies
-        run: npm i -g snyk-delta
-      - uses: snyk/actions/setup@master
-      - name: Perform SCA Scan
-        continue-on-error: false
-        run: |
-          snyk test --all-projects --detection-depth=4 --exclude=docker,Dockerfile --severity-threshold=critical
+      - name: Run Snyk to check for opensource vulnerabilities
+        uses: snyk/actions/node@master
         env:
-          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+          SNYK_TOKEN: ${{ secrets.SNYK_API_TOKEN }}
+        with:
+          args: --all-projects --strict-out-of-sync=false --detection-depth=6 --exclude=docker,Dockerfile --severity-threshold=critical

.github/workflows/snyk_static_analysis_scan.yaml

@@ -1,29 +1,19 @@
 name: Snyk Static Analysis Scan
-# This git workflow leverages Snyk actions to perform a Static Application 
-# Testing scan (SAST) on our first-party code upon Pull Requests to Master & 
-# Develop branches. We use this as a control to prevent vulnerabilities 
-# from being introduced into the codebase. 
+# This SAST (Static Application Security Testing) scan is used to scan
+# our first-party code for security vulnerabilities
 on:
-  pull_request_target:
-    types:
-      - opened
-    branches: 
+  pull_request:
+    branches:
       - master
       - develop
 jobs:
-  Snyk_SAST_Scan :
+  Snyk_SAST_Scan:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: snyk/actions/setup@master
       - name: Perform Static Analysis Test
-        continue-on-error: true
-        run: |
-          snyk code test --all-projects --detection-depth=4 --exclude=docker,Dockerfile --severity-threshold=high
         env:
-          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
-      # The Following Requires Advanced Security License
-      # - name: Upload results to Github Code Scanning
-      #   uses: github/codeql-action/upload-sarif@v1
-      #   with:
-      #     sarif_file: snyk_sarif
+          SNYK_TOKEN: ${{ secrets.SNYK_API_TOKEN }}
+        continue-on-error: true
+        run: snyk code test  --all-projects --strict-out-of-sync=false --detection-depth=6 --exclude=docker,Dockerfile --severity-threshold=high

.github/workflows/triage_closed_issue_comment.yml

@@ -0,0 +1,9 @@
+name: 'Closed Issue Comment'
+on:
+  issue_comment:
+    types:
+      - created
+jobs:
+  closed-issue-comment:
+    uses: cypress-io/cypress/.github/workflows/triage_closed_issue_comment.yml@develop
+    secrets: inherit

README.md

@@ -373,7 +373,7 @@ You can skip the client-side code coverage hooks by setting the environment vari
 # tell Cypress to set environment variable "coverage" to false
 cypress run --env coverage=false
 # or pass the environment variable
-CYPRESS_coverage=false cypress run
+CYPRESS_COVERAGE=false cypress run
 ```
 
 or set it to `false` in the `cypress.json` file
@@ -413,7 +413,7 @@ Full examples we use for testing in this repository:
 - [test-apps/fullstack](test-apps/new-cypress-config/fullstack) instruments and merges backend, e2e and unit test coverage into a single report
 - [test-apps/before-all-visit](test-apps/new-cypress-config/before-all-visit) checks if code coverage works when `cy.visit` is made once in the `before` hook
 - [test-apps/before-each-visit](test-apps/new-cypress-config/before-each-visit) checks if code coverage correctly keeps track of code when doing `cy.visit` before each test
-- [test-apps/one-spec.js](test-apps/new-cypress-config/one-spec.js) confirms that coverage is collected and filtered correctly if the user only executes a single Cypress test
+- [test-apps/one-spec](test-apps/new-cypress-config/one-spec) confirms that coverage is collected and filtered correctly if the user only executes a single Cypress test
 - [test-apps/ts-example](test-apps/new-cypress-config/ts-example) uses Babel + Parcel to instrument and serve TypeScript file
 - [test-apps/use-webpack](test-apps/new-cypress-config/use-webpack) shows Webpack build with source maps and Babel
 - [test-apps/unit-tests-js](test-apps/new-cypress-config/unit-tests-js) runs just the unit tests and reports code coverage (JavaScript source code)