Merge branch 'main' of github.com:abcnews/aunty into bump-dependencies

.github/workflows/tests.yml

@@ -0,0 +1,43 @@
+name: Tests CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Test using Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: '16'
+      - run: npm install
+      - run: npm test
+
+      - name: Tests ✅
+        if: ${{ success() }}
+        run: |
+          curl --request POST \
+          --url https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.sha }} \
+          --header 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' \
+          --header 'content-type: application/json' \
+          --data '{
+            "context": "tests",
+            "state": "success",
+            "description": "Tests passed",
+            "target_url": "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+          }'
+
+      - name: Tests 🚨
+        if: ${{ failure() }}
+        run: |
+          curl --request POST \
+          --url https://api.github.com/repos/${{ github.repository }}/statuses/${{ github.sha }} \
+          --header 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' \
+          --header 'content-type: application/json' \
+          --data '{
+            "context": "tests",
+            "state": "failure",
+            "description": "Tests failed",
+            "target_url": "https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+          }'

.gitignore

@@ -6,3 +6,6 @@ npm-debug.log
 
 # misc
 .DS_Store
+
+# jest temporary folder
+.jest-test-projects

README.md

@@ -120,7 +120,7 @@ If you don't need to override any of the project defaults, your entire aunty con
 | `hasBundleAnalysis` | `false`       | Setting this to true will spin up a second server on another port, allowing you to inspect your bundle. The address will be logged to the console when the dev server starts.                                                                  |
 | `host`              | `"localhost"` | The hostname of your dev server. If you're on the ABC internal network, the default will change to your machine's hostname (`ws<number>.aus.aunty.abc.net.au`). The `AUNTY_HOST` environment variable, if present, will override this setting. |
 | `hot`               | `true`        | Should the dev server enable hot reloading. If `NODE_ENV !== "development"`, the default will change to `false`.                                                                                                                               |
-| `https`             | `true`        | Should the dev server use SSL (with a self-signed certificate matching the `host`). You can alternatively supply your own `{cert: string, key: string}` object if you've generated your certificate some other way.                             |
+| `https`             | `true`        | Should the dev server use SSL (with a self-signed certificate matching the `host`). You can alternatively supply your own `{cert: string, key: string}` object if you've generated your certificate some other way.                            |
 | `port`              | `8000`        | The port number of your dev server. If the port specified is unavailable, **aunty** will try incrementing the port number until it finds an available one. The `AUNTY_PORT` environment variable, if present, will override this setting.      |
 
 #### `deploy` config properties
@@ -142,21 +142,9 @@ You _could_ also specify `type` (`"ftp"`/`"ssh"`), `host`, `port`, `username` &
 
 Aunty comes with a few basic generators. Run `aunty generate --help` for the full list, or `aunty generate <generator> --help` for further details.
 
-### Async/await
-
-One way to add `async`/`await` and generators/`yield` to your project is with the [`regenerator-runtime`](https://www.npmjs.com/package/regenerator-runtime) package.
-
-`npm install regenerator-runtime` and then:
-
-```js
-import 'regenerator-runtime/runtime';
-```
-
-Note: You may also need a `Promise` polyfill for IE11.
-
 ## Authors
 
-- Colin Gourlay ([[email protected]](mailto:[email protected]))
+- Colin Gourlay
 - Simon Elvery ([[email protected]](mailto:[email protected]))
 - Joshua Byrd ([[email protected]](mailto:[email protected]))
 - Nathan Hoad