doc(readme): Add section about release naming conventions - Githubissues

getsentry / craft

The universal Sentry release CLI 🚀

MIT License

133 stars 15 forks source link

doc(readme): Add section about release naming conventions #563

Closed Lms24 closed 2 weeks ago

Lms24 commented 2 weeks ago

This PR adds documentation around version name conventions we require when using craft's prepare and publish commands. Specifically, it documents:

That craft requires semver-like versions
How to name pre-releases
Python post releases
Build metadata/identifiers

This is mostly in line with https://github.com/getsentry/sentry-docs/pull/11787 but I figured it makes sense to also add this to the craft readme itself. Let me know what you think!