Merge origin/dev into codex/issue-1240

Author: JackWilb

.github/ISSUE_TEMPLATE/post_release_checklist.md

@@ -0,0 +1,58 @@
+---
+name: Post-release checklist
+about: Verify deployment and downstream updates after a reVISit release
+title: 'Post-release Checklist vX.Y.Z'
+labels: QA
+assignees: ''
+---
+# Post-release Checklist vX.Y.Z
+
+## [Study Repository](https://github.com/revisit-studies/study)
+
+### Release Automation
+
+- [ ] Confirm the `Release new version` workflow completed successfully
+- [ ] Confirm the release commit and `vX.Y.Z` tag were created and version-pinned URLs reference the new tag
+- [ ] Confirm the GitHub release was created and review the generated release notes
+- [ ] Confirm the production deployment completed successfully
+- [ ] Smoke test the production website
+
+### Storage
+
+- [ ] Run the Firebase cleanup in dry-run mode and review the planned deletions (`./scripts/clear-out-firebase.sh --include-dev --jobs 8`)
+- [ ] Clear Firebase test data (`./scripts/clear-out-firebase.sh --include-dev --jobs 8 --execute`)
+
+## [Documentation Repository](https://github.com/revisit-studies/reVISit-studies.github.io)
+
+- [ ] Confirm the documentation deployment completed successfully
+- [ ] Spot-check the live documentation and library list
+- [ ] Remove old bug fix version
+
+## [Template Repository](https://github.com/revisit-studies/template)
+
+- [ ] Run the `Sync from Upstream` workflow with `upstream_ref` set to `vX.Y.Z`
+- [ ] Confirm the deployment completed successfully
+- [ ] Smoke test the deployed website
+
+## [Replication Studies Repository](https://github.com/revisit-studies/replication-studies)
+
+- [ ] Run the `Sync from Upstream` workflow with `upstream_ref` set to `vX.Y.Z`
+- [ ] Confirm the deployment completed successfully
+- [ ] Smoke test the deployed website
+
+## [ReVISitPy Repository](https://github.com/revisit-studies/revisitpy)
+
+- [ ] Confirm the `Create a new minor version and push to PyPi and GitHub` workflow completed successfully
+- [ ] Confirm the new [`revisitpy`](https://pypi.org/project/revisitpy/) version is available on PyPI
+
+## [ReVISitPy Server Repository](https://github.com/revisit-studies/revisitpy-server)
+
+- [ ] Confirm the `Create a new version and push to PyPi and GitHub` workflow completed successfully
+- [ ] Confirm the new [`revisitpy-server`](https://pypi.org/project/revisitpy-server/) version is available on PyPI
+
+## TODOs
+
+Create or link issues for any bugs found during post-release verification.
+Add any other required follow-up tasks.
+
+- [ ] ...

.github/ISSUE_TEMPLATE/pre_release_checklist.md

@@ -0,0 +1,183 @@
+---
+name: Pre-release checklist
+about: Prepare and review an upcoming reVISit release
+title: 'Pre-release Checklist vX.Y.Z'
+labels: QA
+assignees: ''
+---
+# Pre-release Checklist vX.Y.Z
+
+## Release Pull Request
+
+- [ ] Confirm the release pull request targets `main`
+- [ ] Confirm the pull request title exactly matches `vX.Y.Z`
+- [ ] Confirm all required checks pass
+- [ ] Confirm the pull request has the required approvals
+- [ ] Confirm the release pull request preview deployed successfully
+- [ ] Create the post-release checklist issue and link it here
+
+## [Study Repository](https://github.com/revisit-studies/study)
+
+### Run Studies
+
+Run each study in the release PR preview. Confirm it completes without unexpected errors and its participant data appears correctly in the analysis pages.
+
+#### Demo Studies
+
+- [ ] `demo-html`
+- [ ] `demo-html-input`
+- [ ] `demo-form-elements`
+- [ ] `demo-training`
+- [ ] `demo-html-trrack`
+- [ ] `demo-svelte-trrack`
+- [ ] `demo-react-trrack`
+- [ ] `demo-screen-recording`
+- [ ] `demo-image`
+- [ ] `demo-vega`
+- [ ] `demo-video`
+- [ ] `demo-dynamic`
+- [ ] `demo-condition`
+- [ ] `demo-style`
+- [ ] `demo-yaml`
+- [ ] `demo-ranking-widget`
+- [ ] `demo-upset`
+- [ ] `demo-choropleth-map`
+
+#### Example Studies
+
+- [ ] `example-VLAT-adaptive`
+- [ ] `example-brush-interactions`
+- [ ] `example-cleveland`
+- [ ] `example-llm-chatbot`
+- [ ] `example-mvnv`
+
+#### Tutorials
+
+- [ ] `tutorial`
+- [ ] `tutorial-replication`
+
+#### Tests
+
+- [ ] `test-audio`
+- [ ] `test-component-timeout`
+- [ ] `test-device-restriction`
+- [ ] `test-library`
+- [ ] `test-likert-matrix`
+- [ ] `test-parser-errors`
+- [ ] `test-randomization`
+- [ ] `test-skip-logic`
+- [ ] `test-step-logic`
+
+#### Libraries
+
+- [ ] `library-adaptive-vlat`
+- [ ] `library-beauvis`
+- [ ] `library-berlin-num`
+- [ ] `library-calvi`
+- [ ] `library-color-blindness`
+- [ ] `library-demographics`
+- [ ] `library-graph-literacy-scale`
+- [ ] `library-mic-check`
+- [ ] `library-mini-vlat`
+- [ ] `library-nasa-tlx`
+- [ ] `library-previs`
+- [ ] `library-quis`
+- [ ] `library-sam`
+- [ ] `library-screen-recording`
+- [ ] `library-smeq`
+- [ ] `library-sus`
+- [ ] `library-ueq`
+- [ ] `library-ueq-s`
+- [ ] `library-umux`
+- [ ] `library-umux-lite`
+- [ ] `library-virtual-chinrest`
+- [ ] `library-vlat`
+
+### Analysis Pages
+
+- [ ] Study Summary
+  - [ ] Filter works correctly
+  - [ ] Statistics look correct
+- [ ] Participant View
+  - [ ] Filter works correctly
+  - [ ] Reject / Undo reject participant works correctly
+  - [ ] Replay timeline looks correct
+- [ ] Replay
+  - [ ] Replay works correctly at different play speeds
+  - [ ] Check provenance data (audio, screen, etc.)
+  - [ ] Navigate to the next and previous participant IDs
+  - [ ] Add participant tags
+  - [ ] Navigate to the next and previous participant tasks
+  - [ ] Add task tags
+  - [ ] Load transcripts (e.g. `demo-screen-recording`)
+  - [ ] Download audio/screen recordings (e.g. `demo-screen-recording`)
+  - [ ] Reject / Undo reject participant works correctly
+- [ ] Trial Stats
+  - [ ] Filter works correctly
+  - [ ] Overview stats look correct
+  - [ ] Vega stimulus for answers looks correct
+- [ ] Coding
+  - [ ] Filter works correctly
+  - [ ] Add text tags
+  - [ ] Add annotations
+  - [ ] Replay works correctly at different play speeds
+  - [ ] Navigate to the next and previous participant IDs
+  - [ ] Add participant tags
+  - [ ] Navigate to the next and previous participant tasks
+  - [ ] Add task tags
+  - [ ] Load transcripts (e.g. `demo-screen-recording`)
+  - [ ] Download audio/screen recordings (e.g. `demo-screen-recording`)
+  - [ ] Reject / Undo reject participant works correctly
+- [ ] Live Monitor
+  - [ ] Filter works correctly
+  - [ ] Check participant count header
+  - [ ] Check live monitor tracker
+- [ ] Config
+  - [ ] Filter works correctly
+  - [ ] Download configs (by selecting from the table) / Download config (single download from actions column)
+  - [ ] Compare configs
+  - [ ] View config
+- [ ] Manage
+  - [ ] Changing ReVISit Modes updates the study card and study browser
+  - [ ] Add a new stage and edit stage color
+  - [ ] Create a data snapshot
+  - [ ] Confirm Manage is only accessible to administrators
+- [ ] File download
+  - [ ] JSON export
+  - [ ] Tidy download export
+  - [ ] Download audio recordings
+  - [ ] Download screen recordings
+  - [ ] Download provenance data
+- [ ] Change study from the study dropdown
+- [ ] Click Go to study and confirm it opens the study
+
+### Generated Files
+
+- [ ] If parser types changed, regenerate the study config schemas using `yarn generate-schemas`
+- [ ] If libraries changed, regenerate library documentation and example studies using `yarn generate-library-docs` and `yarn generate-library-examples`
+
+### Documentation
+
+- [ ] Update comments in `store/types.ts`, `parser/types.ts`, `storage/types.ts`, `storage/engines/types.ts`
+- [ ] Update `typedocReadMe.md`
+- [ ] Verify documentation links in the [Study Repository](https://github.com/revisit-studies/study) are up-to-date and point to the current reVISit documentation pages
+
+## [Documentation Repository](https://github.com/revisit-studies/reVISit-studies.github.io)
+
+- [ ] Update documentation for release changes
+- [ ] Update screenshots
+- [ ] Review documentation for accuracy, typos, outdated content, and expired links
+- [ ] Review [library list](https://revisit.dev/docs/designing-studies/plugin-libraries/)
+- [ ] Check the adoption Google Form for newly published papers
+- [ ] Validate example code
+
+## [ReVISitPy Repository](https://github.com/revisit-studies/revisitpy)
+
+- [ ] If parser types or schemas changed, confirm they are compatible with ReVISitPy code generation
+
+## TODOs
+
+Create or link any release-blocking issues or bugs found during release QA.
+Add any other tasks that must be completed before the release.
+
+- [ ] ...