Skip to content

Commit 591ac46

Browse files
authored
Address some minor issues in the release checklists (neuronsimulator#2536)
1 parent 88d7962 commit 591ac46

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

.github/ISSUE_TEMPLATE/release-patch.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,32 @@ Pre-release
2222
Sanity checks
2323
---
2424
- [ ] After cherrypicks PR is merged, make sure GitHub, Azure and CircleCI builds pass for `release/x.y` branch
25-
- [ ] Run [nrn-build-ci](https://github.com/neuronsimulator/nrn-build-ci/actions/workflows/build-neuron.yml) for the `release/x.y` branch; see [nrn-build-ci guide](https://github.com/neuronsimulator/nrn-build-ci#azure-wheels-testing---manual-workflow)
25+
- [ ] Run [nrn-build-ci](https://github.com/neuronsimulator/nrn-build-ci/actions/workflows/build-neuron.yml) for the `release/x.y` branch; see [nrn-build-ci guide](https://github.com/neuronsimulator/nrn-build-ci#azure-wheels-testing---manual-workflow)
2626
- [ ] Activate ReadTheDocs build for `release/x.y` & make it hidden. Check docs are fine after build is done.
2727
- [ ] Run BBP Simulation Stack & other relevant tests
28-
- [ ] Build release wheels but WITHOUT upload ([see details](https://nrn.readthedocs.io/en/latest/install/python_wheels.html#publishing-the-wheels-on-pypi-via-azure))
2928

3029

3130
Releasing
3231
---
3332
- [ ] Create new release+tag on GitHub via [release workflow](https://github.com/neuronsimulator/nrn/actions/workflows/release.yml?query=workflow%3A%22NEURON+Release%22). Note that the GitHub release will be marked as pre-release and will contain the full-src-package and the Windows installer at the end of the release workflow.
34-
- [ ] Create, test and upload manual artifacts
33+
- [ ] Build release wheels but WITHOUT upload ([see details](https://nrn.readthedocs.io/en/latest/install/python_wheels.html#publishing-the-wheels-on-pypi-via-azure))
34+
- [ ] Create, test and upload manual artifacts
3535
- [ ] MacOS package installer (manual task, ask Michael)
3636
- [ ] arm64 wheels (manual task, check with Alex or Pramod)
3737
- [ ] aarch64 wheels (use existing `release/x.y-aarch64` branch for this, see [guide](https://nrn.readthedocs.io/en/latest/install/python_wheels.html#publishing-the-wheels-on-pypi-via-circleci))
3838
- [ ] Publish the `x.y.z` wheels on PyPI; see [wheel publishing instructions](https://nrn.readthedocs.io/en/latest/install/python_wheels.html#publishing-the-wheels-on-pypi-via-azure)
3939
- [ ] Once wheels are published, activate the `x.y.z` tag on ReadTheDocs
4040
- [ ] Rename the Windows installer in the GitHub release to match the new version and the supported python versions (i.e. `nrn-8.2.2.w64-mingw-py-37-38-39-310-311-setup.exe`)
41-
- [ ] Publish release on GitHub (edit https://github.com/neuronsimulator/nrn/releases/tag/x.y.z and un-tick the pre-release checkbox)
41+
- [ ] Publish release on GitHub (edit https://github.com/neuronsimulator/nrn/releases/tag/x.y.z and un-tick the pre-release checkbox)
4242

4343

4444
Post-release
4545
---
4646
- [ ] Deactivate ReadTheDocs build for `release/x.y`
47-
- [ ] Go to [ReadTheDocs advanced settings](https://readthedocs.org/dashboard/nrn/advanced/) and set `Default version` to `x.y.z`
47+
- [ ] Go to [ReadTheDocs advanced settings](https://readthedocs.org/dashboard/nrn/advanced/) and set `Default version` to `x.y.z`
4848
- [ ] Let people know :rocket:
4949
- [ ] Cherrypick changelog and installer links to `master`
50+
- [ ] Update the changelog for the release on GitHub
5051

5152

5253
Changelog

.github/ISSUE_TEMPLATE/release.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,9 @@ Pre-release
1717
Sanity checks
1818
---
1919
- [ ] Create `release/x.y` branch and make sure GitHub, Azure and CircleCI builds pass
20-
- [ ] Run [nrn-build-ci](https://github.com/neuronsimulator/nrn-build-ci/actions/workflows/build-neuron.yml) for the respective Azure build; see [Azure drop guide](https://github.com/neuronsimulator/nrn-build-ci#azure-wheels-testing---manual-workflow)
20+
- [ ] Run [nrn-build-ci](https://github.com/neuronsimulator/nrn-build-ci/actions/workflows/build-neuron.yml) for the respective Azure build; see [Azure drop guide](https://github.com/neuronsimulator/nrn-build-ci#azure-wheels-testing---manual-workflow)
2121
- [ ] Activate ReadTheDocs build for `release/x.y` & make it hidden. Check docs are fine after build is done.
2222
- [ ] Run BBP Simulation Stack & other relevant tests
23-
- [ ] Build release wheels but WITHOUT upload ([see details](https://nrn.readthedocs.io/en/latest/install/python_wheels.html#publishing-the-wheels-on-pypi-via-azure))
2423

2524

2625
Releasing
@@ -30,6 +29,7 @@ Releasing
3029
- [ ] Update `docs/index.rst` accordingly with the new `.pkg` and `.exe` links for `PKG installer` and `Windows Installer`
3130
- [ ] Run the ReadTheDocs build again for `release-x.y`, make sure the build passes and inspect the Changelog page.
3231
- [ ] Create new release+tag on GitHub via [release workflow](https://github.com/neuronsimulator/nrn/actions/workflows/release.yml?query=workflow%3A%22NEURON+Release%22). Note that the GitHub release will be marked as pre-release and will contain the full-src-package and the Windows installer at the end of the release workflow.
32+
- [ ] Build release wheels but WITHOUT upload ([see details](https://nrn.readthedocs.io/en/latest/install/python_wheels.html#publishing-the-wheels-on-pypi-via-azure))
3333
- [ ] Create, test and upload manual artifacts
3434
- [ ] MacOS package installer (manual task, ask Michael)
3535
- [ ] arm64 wheels (manual task, check with Alex or Pramod)
@@ -44,12 +44,13 @@ Releasing
4444
Post-release
4545
---
4646
- [ ] To mark the start of a new development cycle, tag `master` as follows:
47-
- minor version: `x.(y+1).dev`
47+
- minor version: `x.(y+1).dev`
4848
- major version: `(x+1).0.dev`
4949
- [ ] Deactivate ReadTheDocs build for `release/x.y`
50-
- [ ] Go to [ReadTheDocs advanced settings](https://readthedocs.org/dashboard/nrn/advanced/) and set `Default version` to `x.y.z`
50+
- [ ] Go to [ReadTheDocs advanced settings](https://readthedocs.org/dashboard/nrn/advanced/) and set `Default version` to `x.y.z`
5151
- [ ] Let people know :rocket:
5252
- [ ] Cherrypick changelog and installer links to `master`
53+
- [ ] Update the changelog for the release on GitHub
5354

5455
Changelog
5556
======

0 commit comments

Comments
 (0)