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

Derive project version in docs from Git Tags #628

Open
seifertm opened this issue Oct 3, 2023 · 5 comments
Open

Derive project version in docs from Git Tags #628

seifertm opened this issue Oct 3, 2023 · 5 comments

Comments

@seifertm
Copy link
Contributor

seifertm commented Oct 3, 2023

The project version specified in docs/source/conf.py has not been bumped since v0.20.1.

The release field should be derived automatically from the version determined by setuptools_scm, so there's no need to adjust the version manually upon creating a release.

@marcolab
Copy link

Hi! I would like to work on this issue

@seifertm
Copy link
Contributor Author

Great! Let me know if you encounter any issues or if you need a few pointers.

@marcolab
Copy link

I was thinking of simply doing the same as is done in tools/get-version.py. So using importlib.metadata to derive the version in docs/source/conf.py. Would that work?

@seifertm
Copy link
Contributor Author

That sounds like a reasonable approach.

I noticed it's possible for the venv to contain an outdated version of pytest-asyncio. This may lead to outdated values for release, if we go with this approach. However, I think that this problem needs to be handled separately from this issue.

Your approach is the way to go in my opinion.

@menkotoglou
Copy link

Hey @marcolab, did you have the time to look into it? Maybe need a helping hand?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants