sphinx-copybutton

sphinx-copybutton copied to clipboard

While derping around in the source code I saw that you manually parse the version number in your setup.py: https://github.com/executablebooks/sphinx-copybutton/blob/0d53ead4a580b50c595b3f95a039516fbd4c6681/setup.py#L24-L29

So I wanted to recommend bump2version to you. For me this simplified the workflow of releasing a new version quite a lot. You can customice quite a lot, i.e. the commit message

message = 🚀 RELEASE: Version {new_version}

So my workflow to release a new version is simply:

• Update changelog + commit

$ bump2version major|minor|patch
$ git push --follow-tags

And let the CD handle the rest.

P.S.: I also saw the note about using python>=3.4: https://github.com/executablebooks/sphinx-copybutton/blob/0d53ead4a580b50c595b3f95a039516fbd4c6681/doc/index.rst#L61-L63

This could be made obsolete by setting the python_requires kwarg in the setup function to '>=3.4' or '>=3.5' (since py34 is dead).

So I wanted to recommend bump2version to you.

yeh I guess its how it fits into https://executablebooks.org/en/latest/dev-conventions.html#the-process-of-creating-a-release, and whether it would be a help or an added thing to remember

I'm always torn on this one. On the one hand, I like the idea of automating things that we must repetitively do all the time. On the other hand, it feels like extra technical complexity that addresses something that requires very little effort. Now that we're going to go with @chrisjsewell's slightly-not-kosher-but-way-easier-to-follow versioning approach, bumping the version will become:

• Bump the version to what you want in __init__.py
• Make a release commit and push
• Make a release on GitHub

that feels like a nice mix of "manual" and "automatic" to me...