Skip to content

Commit bee697c

Browse files
authored
Release v26.3.0 (#5424)
1 parent 2269256 commit bee697c

File tree

5 files changed

+23
-7
lines changed

5 files changed

+23
-7
lines changed

.github/release_workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ GitHub, PyPI, and conda-forge by the maintainers.
77

88
1. Create and checkout a new release branch (e.g., `release/vYY.MM.0`) from the `main` branch. The year and month are taken from the date of the release. The final number represents the bug fix version, which is zero for a new major release.
99

10-
2. Run `scripts/update_version.py` to update `CITATION.cff` and `CHANGELOG.md`, then create a PR from `release/vYY.MM.0` to `main`.
10+
2. Run `python scripts/update_version.py YY.MM.0` to update `CITATION.cff` and `CHANGELOG.md`, then create a PR from `release/vYY.MM.0` to `main`.
1111

1212
3. Ensure CI passes on the PR, then merge it.
1313

@@ -28,7 +28,7 @@ If a new bugfix release is required after the release of `vYY.MM.{x-1}`:
2828
git cherry-pick -x <commit-sha-from-main>
2929
```
3030

31-
4. Run `scripts/update_version.py` to update `CITATION.cff` and `CHANGELOG.md`, then commit the changes.
31+
4. Run `python scripts/update_version.py YY.MM.x` to update `CITATION.cff` and `CHANGELOG.md`, then commit the changes.
3232

3333
5. Create a new GitHub release with the tag `vYY.MM.x` from the `release/vYY.MM.x` branch (not `main`) and a description copied from `CHANGELOG.md`. This ensures the release contains only the bugfixes, not all changes on `main`. This will automatically trigger `publish_pypi.yml` and create a _release_ on PyPI.
3434

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
## Features
44

5+
## Bug fixes
6+
7+
## Breaking changes
8+
9+
# [v26.3.0](https://github.com/pybamm-team/PyBaMM/tree/v26.3.0) - 2026-03-23
10+
11+
## Features
12+
513
- Improved the performance of processed variables by replacing `casadi.vertcat` input stacking with numpy vectors. ([#5413](https://github.com/pybamm-team/PyBaMM/pull/5413))
614
- Preserve custom variables and events in built-in model to_config ([#5411](https://github.com/pybamm-team/PyBaMM/pull/5411))
715
- Allow out of bounds initial state of charge to enable initialising a simulation at a voltage outside the voltage limits. ([#5386](https://github.com/pybamm-team/PyBaMM/pull/5386))

CITATION.cff

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@ keywords:
2424
- "expression tree"
2525
- "python"
2626
- "symbolic differentiation"
27-
version: "25.12.2"
27+
version: "26.3.0"
2828
repository-code: "https://github.com/pybamm-team/PyBaMM"
2929
title: "Python Battery Mathematical Modelling (PyBaMM)"

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@
9494
"https://books.google.co.uk/books",
9595
"https://docs.scipy.org/doc/scipy", # SciPy docs timeout intermittently
9696
"https://chemrxiv.org", # ChemRxiv blocks automated link checking
97+
"https://pubs.acs.org", # ACS blocks automated link checking
9798
]
9899

99100

scripts/update_version.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,15 @@
22
Automatically update version numbers in various files for releases
33
"""
44

5+
import argparse
56
import os
67
import re
78
from datetime import date
89

9-
from pybamm._version import __version__ as release_version
10-
1110
import pybamm
1211

1312

14-
def update_version():
13+
def update_version(release_version):
1514
"""
1615
Updates version numbers and release information across project files
1716
"""
@@ -39,4 +38,12 @@ def update_version():
3938

4039

4140
if __name__ == "__main__":
42-
update_version()
41+
parser = argparse.ArgumentParser(
42+
description="Update version numbers for a PyBaMM release"
43+
)
44+
parser.add_argument(
45+
"version",
46+
help="Release version, e.g. 26.3 or 26.3.1",
47+
)
48+
args = parser.parse_args()
49+
update_version(args.version)

0 commit comments

Comments
 (0)