|
| 1 | +--- |
| 2 | +name: Simvue Release Epic |
| 3 | +about: Epic issue for release of an iteration of the Simvue framework |
| 4 | +title: Simvue Release vYYMMDD |
| 5 | +labels: release |
| 6 | +assignees: alahiff, james-panayis, kzscisoft, AbyAbraham21, wk9874 |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +# Release Candidate Testing |
| 11 | +The following procedure must be performed when testing and accepting a release candidate. |
| 12 | + |
| 13 | +The versions being tested for this release are: |
| 14 | +| [Server](https://github.com/simvue-io/server) | [UI](https://github.com/simvue-io/web-ui) | [Client](https://github.com/simvue-io/client) | [Integrations](https://github.com/simvue-io/integrations) | [Optimisation](https://github.com/simvue-io/simvue-optim) | |
| 15 | +| --- | --- | --- | --- | --- | |
| 16 | +| [vX.Y.Z]() | [vX.Y.Z]() | [vX.Y.Z]() | [vX.Y.Z]() | [vX.Y.Z]() | |
| 17 | + |
| 18 | +## Pre Testing |
| 19 | + |
| 20 | +- [ ] Update Changelog |
| 21 | +- [ ] Create Release Candidate on Client |
| 22 | +- [ ] Change pyproject.toml on Integrations repo to use RC branch for Client |
| 23 | +- [ ] Create Release Candidate on Integrations |
| 24 | +- [ ] Change pyproject.toml on Optimisation repo to use RC branch for Client and Integrations |
| 25 | +- [ ] Create Release Candidate on Optimisation |
| 26 | +- [ ] Create Release Candidate on UI |
| 27 | +- [ ] Create Release Candidate on Server |
| 28 | +- [ ] Update 'Test' server to use RC candidate for UI and Server |
| 29 | +- [ ] Create Release Candidate branch on Docs |
| 30 | +- [ ] Update MOOSE and FSM docker images to use RC branch |
| 31 | +- [ ] Rebuild MOOSE and FSM docker images locally |
| 32 | +- [ ] Add Changelog to documentation |
| 33 | + |
| 34 | + |
| 35 | +## Testing |
| 36 | +Use the following characters for the result of each test: |
| 37 | +:heavy_check_mark: : Passed |
| 38 | +:x: : Failed, blocking for this release |
| 39 | +:heavy_minus_sign: : Failed, but not blocking for this release |
| 40 | +| Task | Assigned To | Complete? | Result | Issue Raised | Comment | |
| 41 | +| --- | --- | --- | --- | --- | --- | |
| 42 | +| Run Client automated tests |
| 43 | +| Run all steps of MOOSE tutorial in container |
| 44 | +| Run MOOSE example in container |
| 45 | +| Check code in container matches documentation |
| 46 | +| Run FSM example in container |
| 47 | +| Check all documentation is up to date |
| 48 | +| Run all examples from Integrations repository |
| 49 | +| Run all examples from Optimisation repository |
| 50 | +| Check functionality of all elements of web UI |
| 51 | + |
| 52 | +## Release Decision |
| 53 | +Aby to determine the release decision of this release candidate. Base this on the results of the testing above - only when all tests have no blocking issues against them can a release proceed. |
| 54 | + |
| 55 | +### Release Decision: [GO] / [STOP] |
| 56 | + |
| 57 | +## Post Testing |
| 58 | +### If Decision is GO: |
| 59 | +- [ ] Update `CITATION.cff` Citation file in Client |
| 60 | +- [ ] Merge Release Candidate branch into Main on Client repository |
| 61 | +- [ ] Tag Main with version number on Client |
| 62 | +- [ ] Update PyPI with new Client version |
| 63 | +- [ ] Merge Release Candidate branch into Main on Server and UI repositories |
| 64 | +- [ ] Tag Main with version number on Server and UI repositories |
| 65 | +- [ ] Update 'Prod' server with new version of Server and UI code |
| 66 | +- [ ] Update pyproject.toml in Integrations repository to use new Client version |
| 67 | +- [ ] Merge Release Candidate branch into Main on Integrations repository |
| 68 | +- [ ] Tag Main with version number on Integrations |
| 69 | +- [ ] Update PyPI with new Integrations version |
| 70 | +- [ ] Update pyproject.toml in Optimisation repository to use new Client and Integrations version |
| 71 | +- [ ] Merge Release Candidate branch into Main on Optimisation repository |
| 72 | +- [ ] Tag Main with version number on Optimisation |
| 73 | +- [ ] Update PyPI with new Optimisation version |
| 74 | +- [ ] Update MOOSE and FSM Docker images with new Client version in pyproject.toml |
| 75 | +- [ ] Push Docker images to Registry |
| 76 | +- [ ] Merge Release Candidate branch into Main on Docs repository |
| 77 | +- [ ] Inform users about update |
| 78 | +- [ ] Close this issue, label as Passed |
| 79 | + |
| 80 | +### If Decision is STOP: |
| 81 | +- [ ] Assign blocking issues for people to fix |
| 82 | +- [ ] Commit fixes to release candidate branch and to dev branch |
| 83 | +- [ ] Tag branch with updated version number |
| 84 | +- [ ] Raise new Release Acceptance issue |
| 85 | +- [ ] Close this issue, label as Failed |
0 commit comments