Skip to content

Unshallow RTD clone#1045

Merged
sandorkertesz merged 1 commit into
mainfrom
docs/rtd-unshallow
Jun 29, 2026
Merged

Unshallow RTD clone#1045
sandorkertesz merged 1 commit into
mainfrom
docs/rtd-unshallow

Conversation

@sandorkertesz

Copy link
Copy Markdown
Collaborator

Description

Issue with docs where version is wrong because setuptools_scm cannot find the tags because the clone is shallow. This PR should make the clone no longer shallow, and hence fix the issue

From rtd docs:

Read the Docs does not perform a full clone in the checkout job in order to reduce network data and speed up the build process. Instead, it performs a shallow clone and only fetches the branch or tag that you are building documentation for. Because of this, extensions that depend on the full Git history will fail. To avoid this, it’s possible to unshallow the git clone:

.readthedocs.yaml
version: 2
build:
os: "ubuntu-24.04"
tools:
   python: "3.10"
jobs:
   post_checkout:
     - git fetch --unshallow || true

Contributor Declaration

By opening this pull request, I affirm the following:

  • All authors agree to the Contributor License Agreement.
  • The code follows the project's coding standards.
  • I have performed self-review and added comments where needed.
  • I have added or updated tests to verify that my changes are effective and functional.
  • I have run all existing tests and confirmed they pass.

@sandorkertesz
sandorkertesz merged commit 2a8a183 into main Jun 29, 2026
115 checks passed
@sandorkertesz
sandorkertesz deleted the docs/rtd-unshallow branch June 29, 2026 14:35
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.44%. Comparing base (9510385) to head (591ed8e).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1045   +/-   ##
=======================================
  Coverage   82.44%   82.44%           
=======================================
  Files         237      237           
  Lines       16757    16757           
  Branches      818      818           
=======================================
+ Hits        13815    13816    +1     
  Misses       2698     2698           
+ Partials      244      243    -1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants