chore/UIDS-443 Add nightly Percy run in GitHub actions (#473)

Author: brianCollinsUI

.github/workflows/percy-nightly-tests.yml

@@ -0,0 +1,24 @@
+name: "Run Nightly Percy Tests"
+on:
+  schedule:
+    - cron: "0 0 * * *"
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      FONTAWESOME_NPM_AUTH_TOKEN: ${{ secrets.FONTAWESOME_NPM_AUTH_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - run: npm config set "@fortawesome:registry" https://npm.fontawesome.com/
+      - run: npm config set "//npm.fontawesome.com/:_authToken" $FONTAWESOME_NPM_AUTH_TOKEN
+      - name: Install
+        run: yarn
+      - run: npm install -g wait-on
+      - run: yarn storybook & wait-on http://localhost:9009
+      - name: Percy Test
+        uses: percy/[email protected]
+        with:
+          command: "cypress run"
+        env:
+          PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}

README.md

@@ -107,13 +107,16 @@ Trigger a production build when files are changed.
 Remove symlinked packages.
 ### Visual testing
 
-  1. Join BrowserStack (ask Brian for link)
-  1. Navigate to this project in percy [here](https://percy.io/f38ae9b9/ui-design-system)
-  1. Define `PERCY_TOKEN` in shell (the one from ui-design-system project)
-  1. `npx percy exec -- cypress run`
-  1. View results in percy.io / console
+  1. Join BrowserStack team (ask Brian/Bob for link)
+  1. Navigate to this project in [Percy](https://percy.io/f38ae9b9/ui-design-system)
 
-> Note- we are on the free plan (5k images/month) so be mindful of the limit
+  ## Local setup
+  1. Define `PERCY_TOKEN` ENV (the one from ui-design-system project found above)
+  1. Run `yarn storybook` in one tab
+  1. Run `npx percy exec -- cypress run` in another
+  1. View results in percy.io & console
+
+> Note- we are running this once a day via github actions.
 
 ## Pull requests
 

cypress.json

@@ -1,4 +1,5 @@
 {
   "baseUrl": "http://localhost:9009/?path=/story/",
-  "experimentalStudio": true
+  "experimentalStudio": true,
+  "video": false
 }