Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reconsider the release process #182

Open
crdanielbusch opened this issue Jan 14, 2025 · 0 comments
Open

Reconsider the release process #182

crdanielbusch opened this issue Jan 14, 2025 · 0 comments

Comments

@crdanielbusch
Copy link
Contributor

Is your feature request related to a problem? Please describe.

We have a process in place for making a new release. The steps are described in the documentation. It works very well for the ‘happy path’ but gets a bit tricky if something goes wrong.

Examples:
If you type a wrong tag for the new release, 10.0.4 instead of 0.10.4, and then run venv/bin/tbump X.Y.Z all the relevant files will be changed to the wrong number. If a user doesn't know what the command does it may be difficult to reverse the changes. The pre-release changelog items for the release will be deleted and won't show up in the actual changelog for the release if you run the command again.

If you run venv/bin/tbump 0.10.4 on a feature branch instead of the main branch by accident, you are not able to run the same command on the main branch, because the git tag v.0.10.4 already exists.

Describe the solution you'd like

It would be an option to further streamline the process. We could just ask the user which number from X.Y.Z should be counted upwards and the rest happens in Github actions.

Describe alternatives you've considered

We could provide more detailed documentation for reverting changes in the process. We already have a description how to yank a release on pypi.

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

No branches or pull requests

1 participant