Set version step in publish_on_tag is unintuitive and likely redundant

[bglearning]

In the publish_on_tag job we have a Set version step which tries to update the version using hatch version <gh-release-tag-version>.

And so when following the intuitive flow of setting the gh-tag (say 0.0.5) to be the same as the (new) version in __about__.py (0.0.5) we get the error

ValueError: Version <gh-release-tag-version> is not higher than the original version <version-in-about-py>

To get around it we would need to set the gh-tag version be higher than the newly updated about version which doesn't seem right.

So this step seems redundant (?)

[ArzelaAscoIi]

Thanks for raising this issue @bglearning when using the publish_on_tag version, i think the best is just to ignore the about.py and only rely on the GH tag. Is this an option ?

[bglearning]

just to ignore the about.py and only rely on the GH tag

Do you mean ask users to not update about.py and just update in the gh tag? i.e.

• Current version 0.0.5
• User makes changes
• [Skip] User updates about.py -> 0.0.6
• User creates release with 0.0.6
• Job picks up version from gh release and runs hatch version 0.0.6; this updates the about.py

However, this doesn't commit the version update in __about__.py back into the repo? Unless I guess if we add git commands in the job.

I think instead the whole step (Set version) could be removed? And maybe we write in the Readme that users could also use hatch version <new-version> command instead of manually editing __about__.py.
Or is there a downside to doing that?