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

Provide releases or tags #525

Open
sammlapp opened this issue Aug 30, 2024 · 2 comments
Open

Provide releases or tags #525

sammlapp opened this issue Aug 30, 2024 · 2 comments

Comments

@sammlapp
Copy link

Hi, it would be great if the repository occasionally tagged a version, since the API changes frequently. For instance, knowing that you have code working with tag 0.1.0 means you can re-install that version to ensure your code still works in the future.

@jacobgil
Copy link
Owner

Hi, great idea.

Do you know what is the best practice of tags when there is also a pypi version.
Should there be a tag for every new version released on pypi ?

@sammlapp
Copy link
Author

sammlapp commented Sep 4, 2024

Yes, generally you can create more tags than releases but you should have a unique tag for each release. "Semantic versioning" provides a nice guideline in which you have major.minor.patch versions corresponding to PyPi releases, and potentially other tags for more incremental changes.

quoting that doc:

The idea of semantic versioning (or SemVer) is to use 3-part version numbers, major.minor.patch, where the project author increments:

major when they make incompatible API changes,

minor when they add functionality in a backwards-compatible manner, and

patch, when they make backwards-compatible bug fixes.

I believe it's considered ok (by whom? not sure) to have breaking changes (not backwards compatible) in the minor releases for versions <1.0.0, for instance 0.2.0 might introduce breaking changes compared to 0.1.6, but 1.2.0 should not introduce breaking changes compared to 1.1.6.

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

2 participants