Add gh workflow with several different implementations (#89)

* add github workflow

* add another test job using cy gh action

* add actions cache test job

* move env to the right place

* new cache

* describe workflow in README

Author: bahmutov

.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+name: ci
+on: [push]
+jobs:
+  e2e:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v2
+
+      - name: Install and run Cypress tests 🌲
+        uses: cypress-io/github-action@v2
+
+  unit:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v2
+
+      # we are only interested in installing and caching dependencies,
+      # without installing the Cypress binary
+      - name: Install NPM dependencies 📦
+        uses: bahmutov/npm-install@v1
+        env:
+          # we do not need to install Cypress itself
+          # as we do not plan to run tests
+          CYPRESS_INSTALL_BINARY: 0
+
+      - name: Run Jest tests 🧪
+        run: npm test
+
+  unit-using-cypress-gh-action:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v2
+
+      # we are only interested in installing and caching dependencies,
+      # without installing the Cypress binary
+      - name: Install NPM dependencies 📦
+        uses: cypress-io/github-action@v2
+        # we do not want to accidentally overwrite
+        # the full cache created in the e2e test job
+        # because this job does not cache Cypress binary
+        # thus we use custom cache key
+        with:
+          cache-key: unit-cache-v1-${{ runner.os }}-hash-${{ hashFiles('package-lock.json') }}
+        env:
+          # we do not need to install Cypress itself
+          # as we do not plan to run tests
+          CYPRESS_INSTALL_BINARY: 0
+
+      - name: Run Jest tests 🧪
+        run: npm test
+
+  unit-without-any-helpers:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout 🛎
+        uses: actions/checkout@v2
+
+      # use actions/cache to restore / save cache
+      - name: Cache dependencies 💎
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          # use key string with "v1" for simple cache invalidation
+          key: dependencies-v1-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Install dependencies 📦
+        run: npm ci
+        env:
+          # we do not need to install Cypress itself
+          # as we do not plan to run tests
+          CYPRESS_INSTALL_BINARY: 0
+
+      - name: Run Jest tests 🧪
+        run: npm test

README.md

@@ -33,6 +33,20 @@ See the excellent advice on setting TypeScript for Jest and Cypress in [TypeScri
 
 If you hit a problem using Jest and Cypress in the same project, please open an issue in this repository. Include a fork of this repository that shows the problem.
 
+## CircleCI workflow
+
+The file [.circleci/config.yml](./.circleci/config.yml) shows how to run Cypress and Jest tests using [Cypress CircleCI Orb](https://github.com/cypress-io/circleci-orb)
+
+## GitHub Actions workflow
+
+This repo shows how to install dependencies and how to run Jest test in separate jobs on GitHub Actions. See the workflow file [.github/workflows/ci.yml](./.github/workflows/ci.yml) for several different approaches
+
+- install and cache dependencies yourself using [actions/cache](http://github.com/actions/cache)
+- install and cache NPM dependencies using [bahmutov/npm-install](https://github.com/bahmutov/npm-install) helper
+- install and cache NPM dependencies using [cypress-io/github-action](https://github.com/cypress-io/github-action)
+
+**Tip:** you can learn more about running Cypress tests on continuous integration services from [Cypress CI guide](https://on.cypress.io/ci) and [Cypress on CI workshop](https://github.com/cypress-io/cypress-workshop-ci).
+
 ## License
 
 This project is licensed under the terms of the [MIT license](/LICENSE.md).