8000 Prepare release 0.5.0 by rafatahmed · Pull Request #70 · rafatahmed/Flahax · GitHub
[go: up one dir, main page]

Skip to content

Prepare release 0.5.0 - #70

Merged
rafatahmed merged 1 commit into
mainfrom
release/0.5.0
Oct 20, 2026
Merged

rafatahmed merged 1 commit into
mainfrom
release/0.5.0

Conversation

@rafatahmed
Copy link
Copy Markdown
Owner

Prepares FlahaX 0.5.0. Toward #48. Nothing is published. Publication needs your explicit authorization and then the v0.5.0 GitHub Release, which runs the hardened workflow with its reviewer gate.

What 0.5.0 contains (since 0.4.0)

This PR

  • Version alignment: 0.5.0 in pyproject.toml, __version__, CITATION.cff, README (install pin and citation), manual, usage guide and API reference. The changelog section is 0.5.0 — Unreleased; the date is set at publication, as for 0.4.0.
  • User manual:
    • result diagnostics (unmetTargets, targetIonBalance, ammoniumLimit, limitViolations, provenance);
    • chloride consent and the 30-product catalogue;
    • 0.5.0 upgrade notes, including that recipes change;
    • a ninth executed example (Generic Grow's binding ammonium limit). The example count is updated in verify_distribution.py and the release-hygiene test.
  • Release records:
    • the 0.5.0 preparation record in release evidence;
    • release readiness, development status, and a 0.5.0 publishing checklist.

Verification

Check Result
Local regression 373 tests, zero skips, FLAHAX_REQUIRE_PHREEQC=1 (pinned PHREEQC 3.8.6), docs built: Python 3.13.15 and 3.14.0
API vs v0.4.0 103 exports kept, none removed, no signature broken; 18 added (121); 2 keyword-only parameters with defaults
Isolated distribution wheel and sdist clean installs, 9 manual examples, 30 products, all exports, both CLIs
Metadata twine check --strict passed; License-Expression: Apache-2.0; no runtime dependencies
Thermodynamic data chemistry_25c.json unchanged since 0.3.1
Hosted CI on base 9bea54a all jobs passed (run 39515601654)

One thing I caught during the checks: files edited from Python on Windows had been written with CRLF line endings. The repo stores them as LF, so the first candidate build's manual hash would not have matched a build from git. I normalised them to LF and rebuilt; the recorded hashes are the LF ones.

After merge

  1. Hosted CI on the merged revision.
  2. Your explicit authorization to publish 0.5.0.
  3. Create the v0.5.0 GitHub Release; the workflow verifies and waits for your approval of the pypi deployment.
  4. Verify PyPI metadata, hash identity and a fresh install. Record publication evidence, date the changelog and manual.
  5. Confirm Read the Docs stable builds v0.5.0 and serves the benchmark pages, which closes Serve benchmark pages on the stable docs version #48.

Align version 0.5.0 across metadata, runtime, citation, README, manual,
usage guide and API reference; changelog section 0.5.0 - Unreleased.
Update the user manual for 0.5.0: result diagnostics (unmetTargets,
targetIonBalance, ammoniumLimit, limitViolations, provenance), chloride
consent and the 30-product catalogue, upgrade notes (18 added exports,
two keyword-only parameters, recipe changes), with a ninth executed
example on Generic Grow's binding ammonium limit.

Record release readiness: 373 tests with live PHREEQC and zero skips on
Python 3.13.15 and 3.14.0; API compatible with v0.4.0 (103 exports kept,
18 added); isolated wheel/sdist checks and strict Twine checks; resource
hashes; benchmark and comparison evidence. Nothing is published.
@rafatahmed rafatahmed self-assigned this Oct 20, 2026
@read-the-docs-community
Copy link
Copy Markdown

Documentation build overview

📚 Flahax | 🛠️ Build #35283916 | 📁 Comparing 17433a3 against latest (9bea54a)

  🔍 Preview build  

7 files changed · ± 7 modified

± Modified

@rafatahmed
rafatahmed merged commit 692108b into main Oct 20, 2026
6 checks passed
@rafatahmed
rafatahmed deleted the release/0.5.0 branch October 20, 2026 23:46
rafatahmed added a commit that referenced this pull request Nov 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Serve benchmark pages on the stable docs version

1 participant

0