Skip to content

chore(release): improve release guide, check PR title in CI - #2845

Merged
wpbonelli merged 3 commits into
modflowpy:developfrom
wpbonelli:docs/release-guide-caveats
Sep 8, 2026
Merged

chore(release): improve release guide, check PR title in CI#2845
wpbonelli merged 3 commits into
modflowpy:developfrom
wpbonelli:docs/release-guide-caveats

Conversation

@wpbonelli

Copy link
Copy Markdown
Member
  • add a CI job to make sure the PR title follows commit guidelines
  • expand release guide, reference it from DEVELOPER.md

wpbonelli and others added 3 commits September 8, 2026 09:08
Record two things learned from modflow-devtools and modflowapi releases: PyPI
matches a trusted publisher on the org, repo, workflow and environment names,
so a rename silently breaks it; and the conda-forge autotick bot only bumps
the version and hash, so recipe requirements must be checked against the sdist
metadata when dependencies change. Add a Releasing section to DEVELOPER.md
pointing at the release guide.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UVbcrMW2Ax1LwR9bskJdeu
Development pull requests are squash merged, so the title becomes the
commit message the release notes are generated from, and git-cliff drops
anything that is not a conventional commit header without saying so. The
title check runs on every pull request except the bot-opened release and
reset ones, which are not squash merged.

Ports MODFLOW-ORG/modflowapi#115.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GAtFFGBtJSR8f1bY2VNEZT
(cherry picked from commit b63d26b)
Keep the caveat generic to FloPy rather than referring to another project's
release incident.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GAtFFGBtJSR8f1bY2VNEZT
@wpbonelli
wpbonelli marked this pull request as ready for review September 8, 2026 13:20
@codecov

codecov Bot commented Sep 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.6%. Comparing base (556c088) to head (2fb9a4e).
⚠️ Report is 228 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2845      +/-   ##
===========================================
+ Coverage     55.5%    73.6%   +18.0%     
===========================================
  Files          644      659      +15     
  Lines       124135   132282    +8147     
===========================================
+ Hits         68947    97402   +28455     
+ Misses       55188    34880   -20308     

see 586 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@wpbonelli
wpbonelli merged commit 18dc192 into modflowpy:develop Sep 8, 2026
23 checks passed
@wpbonelli
wpbonelli deleted the docs/release-guide-caveats branch September 8, 2026 13:23
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.

1 participant