OpenFreeEnergy / OpenFreeEnergy/openfe

docs build increments the version prematurely

Open
#1,261 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
331
Forks
56
Avg merge
3d 9h
Merged PRs (30d)
13

Description

Describe the bug

setuptools_scm increments the patch/bugfix semver version if the git repo is "dirty" (docs here)

This is an issue in our docs building as of v1.4.0 (when we switched to setuptools_scm), since something about our docs build is triggering this patch version increment:

https://app.readthedocs.org/projects/openfe/builds/27970219/

This only affects our installation docs, so as a short-term fix we can just include the major and minor versions (e.g. 1.4).

Longer-term, I'd like to build our docs such that a fresh version tag is not detected as "dirty". Alternatively, we can use a custom versioning scheme as a long-term solution.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting ReadTheDocs build 27970219 and the installation documentation affected by the version change, then trace how setuptools_scm sees the repository during the docs build. Compare the short-term major/minor-only requirement with the longer-term clean-tag or custom-versioning alternatives; done means the docs no longer show the premature patch increment.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.