Display .dev suffix in release name #79
Merged
Conversation
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
JoeZiminski
approved these changes
Sep 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
What is this PR
Why is this PR needed?
We now also show a "dev" version of the docs (corresponding to the
mainbranch), see #78, but the displayed release doesn't always make sense.For example, if the latest tagged version is
v0.3.3,setuptools_csmwill label commits after that asv0.3.4.dev{N}+{commit-hash}. Our code in Sphinx'sconf.pytrims that to justv0.3.4so it's not apparent that this is a development version ofv0.3.4and instead it looks like the releasev0.3.4.What does this PR do?
It changes the trimming logic such that the
.devsuffix is preserved if present.The hash is still removed. So the above example will be now displayed as
v0.3.4.dev5(number afterdevvaries).References
#78
How has this PR been tested?
Local docs build.
Is this a breaking change?
No.
Does this PR require an update to the documentation?
No.
Checklist: