publish kite report to github pages

Author: ruddell

.github/workflows/app.yml

@@ -58,11 +58,13 @@ jobs:
         run: $SCRIPT_DIR/clone-kite.sh
       - name: 'SETUP: Config Git'
         run: $SCRIPT_DIR/git-config.sh
-      - name: 'INSTALL: Install Browsers and Drivers'
+      - name: 'SETUP: Install Browsers and Drivers'
         run: $SCRIPT_DIR/install-kite.sh
         env:
           KITE_HOME: ${{ runner.workspace }}/KITE
           KITE_SCRIPT_DIR: ${{ runner.workspace }}/KITE/scripts/mac
+      - name: 'PRE-TEST: Display Tools'
+        run: $SCRIPT_DIR/display-tools.sh
       - name: 'TEST: Start Grid'
         run: $SCRIPT_DIR/start-kite.sh
         env:
@@ -73,9 +75,12 @@ jobs:
         env:
           KITE_HOME: ${{ runner.workspace }}/KITE
           KITE_SCRIPT_DIR: ${{ runner.workspace }}/KITE/scripts/mac
-      - name: 'POST-TEST: Display Tools'
-        run: $SCRIPT_DIR/display-tools.sh
+      - name: 'POST-TEST: Generate Kite Report'
+        run: $SCRIPT_DIR/generate-kite-report.sh
         if: ${{ always() }}
+        env:
+          KITE_HOME: ${{ runner.workspace }}/KITE
+          KITE_SCRIPT_DIR: ${{ runner.workspace }}/KITE/scripts/mac
       - name: 'POST-TEST: Upload Artifacts'
         uses: actions/upload-artifact@v2
         if: ${{ always() }}
@@ -88,3 +93,11 @@ jobs:
             ${{ runner.workspace }}/KITE/KITE-Example-Test
             !${{ runner.workspace }}/KITE/KITE-Example-Test/target
             !${{ runner.workspace }}/KITE/KITE-Example-Test/js/node_modules
+      - name: 'POST-TEST: Update Github Pages with Kite Report'
+        if: github.ref == 'refs/heads/main'
+        uses: JamesIves/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.RUDDELL_GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: test/kite/allure-report # The folder the action should deploy.
+          CLEAN: true # Automatically remove deleted files from the deploy branch

.gitignore

@@ -9,6 +9,7 @@ node_modules
 
 # ignore kite files
 test/kite/logs
+test/kite/allure-report
 test/kite/results
 test/kite/target
 test/kite/kite-allure-reports

README.md

@@ -60,7 +60,13 @@ webRtcPeer.ontrack = async ({ track, streams }) => {
 
 #### Local Build
 
-Due to [this React issue](https://github.com/facebook/react/issues/13991), to run locally you will need to link `react` in this project and your application.
+Fork and clone the repository and run:
+
+```javascript
+npm link
+```
+
+If you run `npm install`, it will install the peer-dependencies. Due to [this React issue](https://github.com/facebook/react/issues/13991), you will need to link `react` in this project and your application.
 
 ```bash
 cd node_modules/react
@@ -69,11 +75,3 @@ cd ../../MyApp
 npm link react
 
 ```
-
-Alternatively, you can package the app and install it directly. Note you will need to re-package the app to apply any changes.
-
-```bash
-npm pack
-cd ../MyApp
-npm install ../react-native-webrtc-web-shim/react-native-webrtc-web-shim-*.tgz
-```

test/scripts/generate-kite-report.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+cd ../KITE
+
+# configure $KITE_HOME
+./configureMacCI.sh
+
+echo 'Running tests...'
+cd $GITHUB_WORKSPACE/test/kite
+
+# generates static site for report in allure-report folder
+$KITE_HOME/third_party/allure-2.10.0/bin/allure generate kite-allure-reports