Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions .github/workflows/publish-stub.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,12 @@ jobs:
name: Preflight
runs-on: ubuntu-26.04
# A job of its own because the wait outlasts the build job's ten minutes
# by far. Fifty, above the wait's own forty-five, so the message the wait
# writes is the one a reader gets. The ceiling is not redundant: the loop
# tests its deadline between iterations, so a `gh` call that hangs on a
# stalled connection never reaches the test.
timeout-minutes: 50
# by far. 340 minutes, above the wait's own 330, so the message the wait
# writes is the one a reader gets, and below the 360 a hosted job may run.
# The ceiling is not redundant: the loop tests its deadline between
# iterations, so a `gh` call that hangs on a stalled connection never
# reaches the test.
timeout-minutes: 340
permissions:
actions: read # the conclusion of the CI run on this commit
steps:
Expand All @@ -45,7 +46,7 @@ jobs:
run: |
set -euo pipefail
appear_deadline=$(( SECONDS + 300 ))
finish_deadline=$(( SECONDS + 2700 ))
finish_deadline=$(( SECONDS + 19800 ))
while :; do
# A failed call leaves the substitution empty rather than killing
# the step (a here-string discards its exit status), so name that
Expand Down Expand Up @@ -76,7 +77,7 @@ jobs:
;;
*)
if [ "$SECONDS" -ge "$finish_deadline" ]; then
echo "::error::Python CI still '$status' on $GITHUB_SHA after 45 minutes. Not releasing."
echo "::error::Python CI still '$status' on $GITHUB_SHA after 330 minutes. Not releasing."
exit 1
fi
;;
Expand Down
18 changes: 11 additions & 7 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,15 @@ jobs:
name: Preflight
if: github.repository == 'jmrplens/phonometry'
runs-on: ubuntu-26.04
# Fifty, above the CI wait's own forty-five, so the message the wait
# writes is the one a reader gets. The ceiling is not redundant: the loop
# tests its deadline between iterations, so a `gh` call that hangs on a
# stalled connection never reaches the test.
timeout-minutes: 50
# 340 minutes, above the CI wait's own 330, so the message the wait
# writes is the one a reader gets, and below the 360 a hosted job may run.
# The wait is that long because Python CI on the merge commit takes about
# an hour and can queue for hours behind other runs, and a release that
# gives up first publishes nothing until it is run again by hand. The
# ceiling is not redundant: the loop tests its deadline between
# iterations, so a `gh` call that hangs on a stalled connection never
# reaches the test.
timeout-minutes: 340
permissions:
contents: read
actions: read # the conclusion of the CI run on this commit
Expand Down Expand Up @@ -153,7 +157,7 @@ jobs:
run: |
set -euo pipefail
appear_deadline=$(( SECONDS + 300 ))
finish_deadline=$(( SECONDS + 2700 ))
finish_deadline=$(( SECONDS + 19800 ))
while :; do
# A failed call leaves the substitution empty rather than killing
# the step (a here-string discards its exit status), so name that
Expand Down Expand Up @@ -184,7 +188,7 @@ jobs:
;;
*)
if [ "$SECONDS" -ge "$finish_deadline" ]; then
echo "::error::Python CI still '$status' on $GITHUB_SHA after 45 minutes. Not releasing."
echo "::error::Python CI still '$status' on $GITHUB_SHA after 330 minutes. Not releasing."
exit 1
fi
;;
Expand Down
16,355 changes: 873 additions & 15,482 deletions CHANGELOG.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ authors:
repository-code: "https://github.com/jmrplens/phonometry"
url: "https://docs.jmrp.io/phonometry/"
doi: "10.5281/zenodo.21215280"
version: 4.0.0rc1
date-released: "2026-09-10"
version: 4.0.0
date-released: "2026-11-17"
license: MIT
keywords:
- acoustics
Expand Down
29 changes: 26 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -759,19 +759,42 @@ enforces it.

Releases are fully automated from the repository-root `VERSION` file:

1. Open a PR that bumps `VERSION` (semver) and carries the three things that
have to move with it. Bumping `VERSION` on its own turns the build red.
- Move the `[Unreleased]` CHANGELOG section to the new version.
1. Open a PR that bumps `VERSION` (semver) and carries everything that has
to move with it. Bumping `VERSION` on its own turns the build red.
- Move the `[Unreleased]` CHANGELOG section under a heading for the new
version, dated the day the PR merges (UTC), and leave an empty
`[Unreleased]` above it for the next changes. At the foot of the file,
`[Unreleased]` then compares the new tag with `HEAD`, and the new
version gets a link that compares the previous release with its tag.
- Update `CITATION.cff`'s `version` and `date-released` to match.
`site/src/data/citation.mjs` fails the build when the CFF's `version`
differs from `VERSION`, or when its `date-released` is later than the
CHANGELOG heading for that version, and the docs workflow runs on any
PR touching any of them.
- Write the new version into the citations of the About page by hand, the
APA line and the BibTeX `version`, in its three editions
(`site/src/content/docs/start/about.md`,
`site/src/content/docs/es/start/about.md` and `docs/start/about.md`):
`site/src/data/citation.mjs` fails the build when either names a
version other than `VERSION`.
- Write the new version into the `__version__` row of
`docs/reference/api/index.md` by hand. `make api-docs` leaves that cell
alone, and `scripts/check_api_reference.py` fails when it differs from
the installed `phonometry.__version__`, so reinstall first
(`pip install -e .`): the version an installed package reports comes
from its metadata, not from `VERSION`.
- Run `make conformance`, which writes the new version into
`docs/conformance.json` and regenerates `docs/CONFORMANCE.md` and the
badges.
- Run `make pypi-readme` and commit `README_PYPI.md`. The PyPI page pins
every link into this repository to the release tag and reads that tag
from `VERSION`, so a bump on its own leaves the whole guide map on the
published page pointing at the previous release. The packaging tests
fail until the page is regenerated.
- Run `make llms` last: `llms.txt` and its shards read `VERSION`,
`docs/conformance.json`, the About page and the API table, so it has to
come after every edit above, or the check that the llms files are up to
date fails.
2. Before merging it, rehearse the release: run the **Release** workflow by
hand on the PR's branch (Actions, Release, Run workflow). A manual run is
always a rehearsal and no input turns it into a release. It reads the
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ figure in the documentation.*
pip install phonometry
```

If phonometry 3.x is already installed, upgrade it with
`pip install -U phonometry`, naming the extras you use
(`pip install -U "phonometry[full]"` for all four where `[full]` installs);
3.x has a different import layout and `from phonometry import filters` fails
on it. Code written for 3.x needs changes to run on 4.x; the
[upgrade guide](https://docs.jmrp.io/phonometry/start/upgrading/) maps each of
them.

phonometry needs Python 3.12 or newer, with NumPy 2.0.2 and SciPy 1.14.0
or later. Each of those floors, and each floor of the extras, is the oldest
release the library's tests pass with, and a CI job installs exactly those
Expand Down
Loading
Loading