Skip to content

Commit 9bb6eed

Browse files
authored
Update workflow (#4948)
1 parent b5a188f commit 9bb6eed

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

.github/release_workflow.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,31 @@
33
This file contains the workflow required to make a `PyBaMM` release on
44
GitHub, PyPI, and conda-forge by the maintainers.
55

6-
## Initial release (automated)
6+
## Creating a release
77

8-
1. The `update_version.yml` workflow will run on every 1st of January, May
9-
and September, updating incrementing the version to `vYY.MM.0` by running
10-
`scripts/update_version.py` in the following files:
8+
1. Checkout the latest develop branch, then create a local tag `vYY.MM.0`
9+
with the new version. The year and month are taken from the date of the
10+
release. The final number represents the bug fix version, which is zero for
11+
a new release.
12+
13+
2. Run `scripts/update_version.py` to update the following files:
1114

1215
- `CITATION.cff`
1316
- `CHANGELOG.md`
1417

15-
These changes will be automatically pushed to a new branch `vYY.MM`
16-
and a PR from `vYY.MM` to `main` will be created.
18+
These changes should be pushed to a release branch `vYY.MM.0`
19+
and a PR from `vYY.MM.0` to `main` needs to be created.
1720

18-
2. Create a new GitHub _release_ with the tag `vYY.MM.0` from the `vYY.MM`
19-
branch and a description copied from `CHANGELOG.md`.
21+
3. After the release PR has been merged, create a new GitHub _release_ with the
22+
tag `vYY.MM.0` from the `vYY.MM` branch and a description copied from
23+
`CHANGELOG.md`.
2024

21-
3. This release will automatically trigger `publish_pypi.yml` and create a
25+
4. This release will automatically trigger `publish_pypi.yml` and create a
2226
_release_ on PyPI.
2327

24-
## Bug fix releases (manual)
28+
## Bug fix releases
2529

26-
If a new release is required after the release of `vYY.MM.{x-1}` -
30+
If a new bugfix release is required after the release of `vYY.MM.{x-1}` -
2731

2832
1. Create a new branch for the `vYY.MM.x` release using the `vYY.MM.{x-1}` tag.
2933

0 commit comments

Comments
 (0)