Document GitHub tag format for pre-release versions (alphas, betas, release candidates, etc) #315
Comments
1 task
dbeatty10
added a commit
to dbt-labs/docs.getdbt.com
that referenced
this issue
Apr 26, 2024
…tax (#5361) [Preview](https://docs-getdbt-com-git-dbeatty10-patch-2-dbt-labs.vercel.app/docs/build/packages#prerelease-versions) ## What are you changing in this pull request and why? dbt-labs/hubcap#315 describes the difference between prerelease versions in SemVer 2.0 ("semantic versioning") and PEP 440 (used in the Python packaging ecosystem). While the current example technically does work, it would more clearly align with SemVer 2.0 if we update the example. ## Checklist - [x] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. --------- Co-authored-by: Mirna Wong <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
TLDR
All tags that conform to SemVer 2.0.0 will work. ✅
But not all tags that conform to PEP 440 will work. ❌
More detail
As mentioned in #129, the
hubcap.pyscript requires tag versions that adhere strictly to SemVer 2.0.0. So alphas, betas, release candidates, etc. require a format like these:3.0.0-dev.32.0.0-rc101.0.0-b10.1.0-a2There are version specifiers that are valid in PEP 440 but not able to be accepted by
hubcap.pylike these:3.0.0dev.32.0.0rc101.0.0b10.1.0a2We want to document this so that we have something to point to and gives guidance to package maintainers.
Alternatives considered
We could choose to adopt the functionality described in #130 instead.
The text was updated successfully, but these errors were encountered: