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

docs/conf.py has a hardcoded (and wrong) version string #680

Closed
grahamgower opened this issue Nov 3, 2020 · 2 comments · Fixed by #1674 or #1675
Closed

docs/conf.py has a hardcoded (and wrong) version string #680

grahamgower opened this issue Nov 3, 2020 · 2 comments · Fixed by #1674 or #1675
Assignees
Labels
good first issue Good for newcomers
Milestone

Comments

@grahamgower
Copy link
Member

This should be read from the version in stdpopsim/_version.py. E.g.
https://github.com/tskit-dev/tskit/blob/main/docs/conf.py#L52-L53

@grahamgower grahamgower added the good first issue Good for newcomers label Nov 3, 2020
@jeromekelleher
Copy link
Member

Since stdpopsim uses setuptools_scm, it's better to use their infrastructure for determining the version. See how msprime does it here

(FYI tskit doesn't use setuptools_scm because it's a multi-package repo and this confused setuptools_scm)

@andrewkern
Copy link
Member

reopening this because even though #1674 includes the version, the github action we are using (checkout@v4) doesn't by default clone the repo with the tags (which is where setuptools_scm looks for version/release info). instead it does a shallow clone of the repo.

the fix i believe is to give the action here an option that looks like

with:
    fetch-depth: 0 # will get all tags

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
4 participants