chore: add DEVELOPER.md, fold in pub guide, simplify version script - #123
Open
wpbonelli wants to merge 3 commits into
Open
chore: add DEVELOPER.md, fold in pub guide, simplify version script#123wpbonelli wants to merge 3 commits into
wpbonelli wants to merge 3 commits into
Conversation
Move the release procedure from guide-to-publish.md into a new DEVELOPER.md that also covers development setup, linting and testing, matching the layout of modflow-devtools. Includes the conda-forge step and the trusted-publisher rename caveat. Link it from the README. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UVbcrMW2Ax1LwR9bskJdeu
Drop the tag-relative --bump {major,minor,patch,dev}. It shelled out to
git tag and kept a second source of truth alongside version.txt that could
disagree with it, and the 'dev' choice was a --bump value that ignored tags
entirely. The development version on develop already names the next release,
so --release derives it by stripping the development suffix (1.2.0.dev0 ->
1.2.0).
Rename --get to --dry-run, move the "Updated ..." lines to stderr, and print
the resolved version on stdout whether or not it was written. The develop
reset previously ran the script twice -- once to compute the next version,
once to write it -- in an order that silently double-bumped if reversed;
`next=$(update_version.py --post-release)` now does both.
Rename --next-dev to --post-release: it pairs with --release, and "next dev"
read like incrementing the .devN counter.
The dispatch form loses the bump input; the common case needs no input at
all, and the version input still overrides.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UVbcrMW2Ax1LwR9bskJdeu
wpbonelli
marked this pull request as ready for review
September 8, 2026 12:00
wpbonelli
added a commit
to MODFLOW-ORG/modflow-devtools
that referenced
this pull request
Sep 8, 2026
…ion script (#354) * add release instructions to DEVELOPER.md * automate the post-release reset step in the release workflow * add --release and --post-release options to update_version.py cf MODFLOW-ORG/modflowapi#123
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two things
One, add a
DEVELOPER.mdfile with instructions on setting up an environment, linting, testing, and releasing (folded in fromguide-to-publish.mdetc).Two, simplify
update_version.pyto--bumpandgitinspection--releaseto strip.devNsegment--post-releaseto bumpminor +1and append.dev0--get--dry-runto control whether anything is writtenThe
--bumpoption didn't buy much, just saved typing a version number. IMO it's simpler to specify a version explicitly or just treatversion.txtas the source of truth when version isn't explicitly specified. and alsogittags aren't always available e.g. in a shallow clone.Overall I think this is a smaller user interface that's easier to reason about
update_version.py1.2.0.dev0(unchanged)update_version.py --dry-run1.2.0.dev0update_version.py -v 1.5.01.5.0update_version.py -v 1.5.0 --dry-run1.5.0update_version.py --release1.2.0(strip.dev)update_version.py --release --dry-run1.2.0update_version.py --post-release1.3.0.dev0(minor +1,.dev0)update_version.py --post-release --dry-run1.3.0.dev0The main use cases being
--release --dry-run→ release workflow's "Resolve version" step: get the version to be released-v X→ release workflow's "Update version" step, and any ad-hoc use--post-release→ post-release reset workflow--dry-runalone → "what version is this"This pattern could be followed for
update_version.pyeverywhere