Fix checkout tags #510

d-chambers · 2025-08-03T03:45:37Z

Description

Issue #493 notes the documentation build doesn't list the correct version in the upper left corner like it should. Now things are more broken as the recent doc-build failed in the checkout action. I think something changed in the checkout action and we now need to explicitly set the depth to 0 (see here) because only fetch-tags is specified as true currently (see here). This PR simply makes that change.

Checklist

I have (if applicable):

referenced the GitHub issue this PR closes.
documented the new feature with docstrings or appropriate doc page.
included a test. See testing guidelines.
your name has been added to the contributors page (docs/contributors.md).
added the "ready_for_review" tag once the PR is ready to be reviewed.

Summary by CodeRabbit

Chores
- Updated workflows to fetch the full git history and all tags during repository checkout, improving consistency and reliability across build, test, lint, documentation, and deployment processes.
- Minor formatting adjustments to workflow files for clarity and maintainability.

coderabbitai · 2025-08-03T03:45:44Z

Walkthrough

The GitHub Actions workflows were updated to modify the actions/checkout@v4 step, ensuring that all jobs now fetch the complete git history and all tags (fetch-depth: '0', fetch-tags: "true"). Some workflows also had minor formatting adjustments to matrix syntax and quotations, but no changes to workflow logic or exported entities.

Changes

Cohort / File(s)	Change Summary
Docs Build & Deploy Workflows `.github/workflows/build_deploy_master_docs.yaml`, `.github/workflows/build_deploy_stable_docs.yaml`	Updated checkout step to include `fetch-depth: '0'` and `fetch-tags: "true"`, ensuring full git history and tags are fetched for documentation build and deploy workflows.
Test & Lint Workflows `.github/workflows/get_coverage.yml`, `.github/workflows/lint.yml`, `.github/workflows/runtests.yml`, `.github/workflows/test_doc_build.yml`	Modified checkout steps to add `fetch-depth: '0'` and standardize `fetch-tags` as `"true"`. This ensures all test and lint workflows have access to full git history and tags. Minor formatting changes to quotes in some files.
Minimal Dependency Tests Workflow `.github/workflows/run_min_dep_tests.yml`	Reformatted matrix syntax for OS and Python versions, updated checkout step to add `fetch-depth: '0'` and standardize `fetch-tags` as `"true"`. No logic or control flow changes.
PyPI Upload Workflow `.github/workflows/upload_pypi.yml`	Replaced manual `git fetch --tags --force` step with `fetch-depth: '0'` and `fetch-tags: "true"` in checkout action, consolidating tag/history fetching into the checkout step.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

CI, documentation

Poem

🐇
In the warren of workflows, we dig a bit deep,
Fetching all history, no secrets to keep.
Tags and commits, now fully in view,
Our CI is thorough, our docs shiny and new!
With every checkout, the story’s complete—
A rabbit’s delight in a codebase so neat.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix_checkout_tags

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-08-03T03:48:31Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.85%. Comparing base (c98d61c) to head (9c2e834).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #510   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files         118      118           
  Lines        9713     9713           
=======================================
  Hits         9699     9699           
  Misses         14       14

Flag	Coverage Δ
unittests	`99.85% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

coderabbitai

Actionable comments posted: 0

♻️ Duplicate comments (4)

.github/workflows/runtests.yml (1)

44-47: See DRY recommendation in previous comment
The feedback given for the stable-docs workflow applies here as well.

.github/workflows/build_deploy_master_docs.yaml (1)

35-39: Same duplication note as above

.github/workflows/get_coverage.yml (1)

13-17: Same duplication note as above

.github/workflows/test_doc_build.yml (1)

14-18: Same duplication note as above

🧹 Nitpick comments (4)

.github/workflows/build_deploy_stable_docs.yaml (1)
30-33: fetch-depth: 0 is the right fix, but please avoid duplicating this stanza everywhere

Adding
fetch-tags: "true"
fetch-depth: '0'
is exactly what the checkout action now expects – good catch.
The same two-line block was added to seven other workflows in this PR. To keep future maintenance friction-free, consider wrapping the checkout logic in a small reusable workflow or composite action (e.g. .github/actions/checkout-full) and call that from each job instead of repeating the options in every file.
.github/workflows/upload_pypi.yml (1)

14-15: Redundant fetch-tags when fetch-depth: '0'
For actions/checkout@v4, setting fetch-depth: 0 already instructs the action to fetch the full history including tags. Adding fetch-tags: "true" is harmless but redundant and slightly increases maintenance surface. Consider dropping the line for brevity unless you prefer the explicitness for readability.

.github/workflows/lint.yml (1)

15-16: Minor redundancy identical to other workflow
Same note as in upload_pypi.yml: fetch-depth: '0' alone is sufficient. Keeping both keys is fine, but you can simplify.

.github/workflows/run_min_dep_tests.yml (1)

38-39: Same redundancy remark as other workflows
fetch-depth: '0' already pulls tags; fetch-tags is optional. Feel free to drop for consistency.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c98d61c and 9c2e834.

📒 Files selected for processing (8)

.github/workflows/build_deploy_master_docs.yaml (1 hunks)
.github/workflows/build_deploy_stable_docs.yaml (1 hunks)
.github/workflows/get_coverage.yml (1 hunks)
.github/workflows/lint.yml (1 hunks)
.github/workflows/run_min_dep_tests.yml (1 hunks)
.github/workflows/runtests.yml (1 hunks)
.github/workflows/test_doc_build.yml (1 hunks)
.github/workflows/upload_pypi.yml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (15)

GitHub Check: test_code_min_deps (windows-latest, 3.12)
GitHub Check: test_code_min_deps (windows-latest, 3.13)
GitHub Check: test_code_min_deps (ubuntu-latest, 3.12)
GitHub Check: test_code (windows-latest, 3.11)
GitHub Check: test_code_min_deps (macos-latest, 3.12)
GitHub Check: test_code_min_deps (macos-latest, 3.13)
GitHub Check: test_code_min_deps (ubuntu-latest, 3.13)
GitHub Check: test_code (macos-latest, 3.12)
GitHub Check: test_code (macos-latest, 3.11)
GitHub Check: test_code (windows-latest, 3.12)
GitHub Check: test_code (windows-latest, 3.10)
GitHub Check: test_code (macos-latest, 3.10)
GitHub Check: test_code (ubuntu-latest, 3.11)
GitHub Check: test_code (ubuntu-latest, 3.12)
GitHub Check: test_code (ubuntu-latest, 3.10)

🔇 Additional comments (1)

.github/workflows/run_min_dep_tests.yml (1)

28-30: No gating required for Python 3.13
actions/setup-python@v5 already supports installing Python 3.13 on ubuntu-latest, macos-latest, and windows-latest runners. You can safely keep the matrix entry as-is.

ahmadtourei · 2025-08-04T17:10:16Z

Looks good! Should we do a new release after merging this?

d-chambers · 2025-08-06T19:23:40Z

Looks good! Should we do a new release after merging this?

Sure, let's give it a go.

ahmadtourei · 2025-08-06T21:06:42Z

Looks good! Should we do a new release after merging this?

Sure, let's give it a go.

Yaay it's fixed now!

d-chambers added 3 commits August 2, 2025 20:28

try checkout action

4b27455

remove action

903477c

add checkout depths

9c2e834

d-chambers requested a review from ahmadtourei August 3, 2025 03:45

coderabbitai bot reviewed Aug 3, 2025

View reviewed changes

ahmadtourei approved these changes Aug 4, 2025

View reviewed changes

d-chambers merged commit 2d2a7dd into master Aug 6, 2025
19 checks passed

d-chambers deleted the fix_checkout_tags branch August 6, 2025 19:23

ahmadtourei mentioned this pull request Aug 6, 2025

issue with stable docs build #493

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix checkout tags #510

Fix checkout tags #510

Uh oh!

d-chambers commented Aug 3, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 3, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Aug 3, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

ahmadtourei commented Aug 4, 2025

Uh oh!

d-chambers commented Aug 6, 2025

Uh oh!

Uh oh!

ahmadtourei commented Aug 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix checkout tags #510

Fix checkout tags #510

Uh oh!

Conversation

d-chambers commented Aug 3, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested labels

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Aug 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

ahmadtourei commented Aug 4, 2025

Uh oh!

d-chambers commented Aug 6, 2025

Uh oh!

Uh oh!

ahmadtourei commented Aug 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

d-chambers commented Aug 3, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 3, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Aug 3, 2025 •

edited

Loading