Merge remote-tracking branch 'upstream/master' into gscan-filter

Author: MetRonnie

.github/ISSUE_TEMPLATE/bug-report.md

@@ -26,6 +26,11 @@ jobs:
         with:
           ref: ${{ env.MERGE_SHA }}
 
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
       - name: Install
         run: yarn install
 

.github/ISSUE_TEMPLATE/feature-request.md

@@ -10,4 +10,4 @@ networkSettings:
 
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-3.3.1.cjs
+yarnPath: .yarn/releases/yarn-3.4.1.cjs

.github/PULL_REQUEST_TEMPLATE.md

@@ -11,7 +11,7 @@ creating a new release entry be sure to copy & paste the span tag with the
 updated. Only the first match gets replaced, so it's fine to leave the old
 ones in. -->
 -------------------------------------------------------------------------------
-## __cylc-ui-1.5.0 (<span actions:bind='release-date'>Upcoming</span>)__
+## __cylc-ui-1.5.0 (<span actions:bind='release-date'>Released 2023-02-20</span>)__
 
 ### Enhancements
 
@@ -23,6 +23,10 @@ cycle point and family in tree & table views.
 
 ### Fixes
 
+[#1230](https://github.com/cylc/cylc-ui/pull/1230) -
+Fixes an issue where tasks were missing from the GUI in workflows which
+use multi-level family inheritance.
+
 [#1182](https://github.com/cylc/cylc-ui/pull/1182) - Fixes bug in filtering
 by task name.
 

.github/workflows/auto_publish_release.yml

@@ -1,29 +1,37 @@
-# Cylc UI: How to Contribute
+# Cylc: How to Contribute
 
-## Report Bugs
+Thanks for you interest in the Cylc project!
 
-Report bugs by opening an issue [on
-Github](https://github.com/cylc/cylc-ui/issues). Give the version
-affected by the bug (you should test the latest release if possible) and a
-recipe to reproduce the problem.
+Contributions are welcome, please open an issue to discuss changes before
+raising a pull request.
 
-## Request Enhancements
+You can also get in touch via:
+
+* The developers chat: [![chat](https://img.shields.io/matrix/cylc-general:matrix.org)](https://matrix.to/#/#cylc-general:matrix.org)
+* The forum: [![forum](https://img.shields.io/discourse/https/cylc.discourse.group/posts.svg)](https://cylc.discourse.group/)
+
+
+## New Contributors
+
+Please read the [CLA](#contributor-licence-agreement-and-certificate-of-origin).
+
+Please add your name to the
+[Code Contributors](#code-contributors) section of this file as part of your
+first Pull Request (for each Cylc repository you contribute to).
 
-Request enhancements by opening an issue at [Github
-](https://github.com/cylc/cylc-ui/issues). Describe your use case in
-detail.
 
 ## Contribute Code
 
-All contributions to project are made via Pull Requests against the *master*
-branch of [cylc/cylc-ui](https://github.com/cylc/cylc-ui).
-Non-trivial developments must be discussed and agreed in advance in a
-[Issue](https://github.com/cylc/cylc-ui/issues) as the team may not
-be able to consider large changes that appear out of the blue. New
-contributors should add their details to the [Code Contributors
-](#code-contributors) section of this file as part of their first Pull
-Request, and reviewers are responsible for checking this before merging the
-new branch into *master*.
+**Enhancements** are made on the `master` branch.
+
+**Bugfixes** are made on the branch of the same name as the issue's milestone.
+E.G. if the issue is on the `8.0.x` milestone, branch off of `8.0.x` to
+develop your bugfix, then raise the pull request against the `8.0.x` branch.
+We will later merge the `8.0.x` branch into `master`.
+
+Feel free to ask questions on the issue or developers chat if unsure about
+anything.
+
 
 ## Code Contributors
 

.yarn/releases/yarn-3.3.1.cjs

@@ -24,9 +24,83 @@ PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 You should have received a copy of the GNU General Public License along with
 Cylc.  If not, see [GNU licenses](http://www.gnu.org/licenses/).
 
-## Developers
+## Development
 
-### Building
+### Install & Build
+
+```bash
+# Project setup
+yarn install
+
+# build & run in offline mode (uses mock data, auto-reloads the browser on change)
+yarn run serve
+
+# build for development (rebuilds on change)
+# launch using `cylc gui --ui-build-dir=<path>`
+# (where path is the path to the `dist/` folder created by build
+yarn run build:watch
+
+# build for production
+yarn run build
+
+# Produce build report
+yarn run build:report
+```
+
+### Tests
+
+There are three groups of tests:
+
+* Unit tests
+  * Simple unit tests for individual functions and classes.
+  * **Framework:** Mocha
+  * **Assertions:** Chai
+  * **Path:** `tests/unit`
+  * **Command:** `yarn run test:unit`
+  * (To watch add `--watch`)
+* Component tests
+  * In-browser tests which mount a single Vue component standalone.
+  * **Framework:** Cypress
+  * **Assertions:** Chai
+  * **Path:** `cypress/component`
+  * **Command:** `yarn run test:e2e` (navigate to component page)
+  * (For "headless" mode add `-- --headless --config video=false`)
+* End to end tests
+  * In-browser tests which load entire pages of the UI using mocked data.
+  * **Framework:** Cypress
+  * **Assertions:** Chai
+  * **Path:** `tests/e2e`
+  * **Command:** `yarn run test:e2e` (navigate to e2e page)
+  * (For "headless" mode add `-- --headless --config video=false`)
+
+For coverage:
+```
+yarn run coverage:unit
+```
+
+Useful test opts:
+- `--bail`: exit after first test failure
+- `--colors`: enables coloured output in VSCode integrated terminal
+
+### Mocked Data
+
+The "offline" mode (aka `yarn run serve`) which is also used for the end to end
+tests is powered by "mock" data.
+
+You can find the index of mocked data here: `src/services/mock/json/index.js`
+
+Mock data is automatically loaded when the subscription/query issued matches
+an entry in that file.
+
+### Code Style
+
+See `.eslintrc.js` for style, to test run:
+
+```
+yarn run lint
+```
+
+### Project Setup
 
 This project was created with the [vue-cli](https://cli.vuejs.org/).
 
@@ -111,76 +185,6 @@ module.exports = {
 (`.browserslistrc`) to determine the polyfills needed. See
 https://cli.vuejs.org/guide/browser-compatibility.html.
 
-#### Project setup
-
-```
-yarn install
-```
-
-#### Compiles and hot-reloads demo mode for development
-
-```
-yarn run serve
-```
-
-#### Compiles and minifies for production
-
-```
-yarn run build
-```
-
-#### Compiles and watch for changes for development
-
-```
-yarn run build:watch
-```
-
-#### Produce build report
-
-```
-yarn run build:report
-```
-
-#### Run unit tests
-
-```
-yarn run test:unit
-```
-
-Useful opts:
-- `--watch`: watch for changes (allows re-running tests much quicker)
-- `--bail`: exit after first test failure
-- `--colors`: enables coloured output in VSCode integrated terminal
-
-For coverage:
-```
-yarn run coverage:unit
-```
-
-#### Run functional tests
-
-```
-yarn run test:e2e
-```
-
-Or for headless mode
-
-```
-yarn run test:e2e -- --headless --config video=false
-```
-
-For coverage
-
-```
-yarn run coverage:e2e
-```
-
-#### Lints and fixes files
-
-```
-yarn run lint
-```
-
 ### Integration with the backend Cylc UI server
 
 In the previous section _"Compiles and watch for changes for development"_,