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

build: migrate from bump-my-version to versioningit #1832

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

egparedes
Copy link
Contributor

@egparedes egparedes commented Jan 29, 2025

Use versioningit as a setuptools plugin to use the information in git tags as source of truth for the distribution package versioning. This should allow for a much finer version specification, since essentially every commit defines a new version, even when installed in editable mode. Some other important packages are following similar approaches (e.g. jax).

TODO:

  • Update outdated release documentation
  • Add tests
  • Add pyproject.toml export-subst to .gitattributes as explained in the git-archive method documentation
  • Look for corner cases where it might break
    • Install from git archive provided from github
    • Install from arbitrary zip file with and without .git repo

@egparedes egparedes changed the title Move to versioningit build: migrate from bump-my-version to versioningit Jan 29, 2025
@egparedes egparedes force-pushed the move-to-versioningit branch 2 times, most recently from 11a6ed9 to da406e7 Compare January 29, 2025 12:26
@egparedes egparedes changed the base branch from migrate-to-uv to main January 29, 2025 14:54
@egparedes egparedes force-pushed the move-to-versioningit branch 2 times, most recently from 3ca0095 to 9f10bc6 Compare January 30, 2025 07:59
@egparedes egparedes force-pushed the move-to-versioningit branch from 9f10bc6 to c610259 Compare January 30, 2025 15:37
Comment on lines -16 to 23

4. Commit the changes with the following message:
4. Tag the previous commit with the exact `v{M}.{m}.{p}` tag to update the version number and push all the changes:

```bash
$ git commit -m 'Releasing {M}.{m}.{p} version.'
$ git tag v0.1.2 # replace by the right version tag
$ git push origin master
$ git push --tags origin
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is implicit in the next step.

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

Successfully merging this pull request may close these issues.

2 participants