dbt-labs / hubcap

This app adds modules to the hubsite at hub.getdbt.com
13 stars 100 forks source link

Document GitHub tag format for pre-release versions (alphas, betas, release candidates, etc) #315

Open dbeatty10 opened 6 months ago

dbeatty10 commented 6 months ago

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 https://github.com/dbt-labs/hubcap/issues/129, the hubcap.py script requires tag versions that adhere strictly to SemVer 2.0.0. So alphas, betas, release candidates, etc. require a format like these:

There are version specifiers that are valid in PEP 440 but not able to be accepted by hubcap.py like these:

We 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 https://github.com/dbt-labs/hubcap/pull/130 instead.