Skip to content

fix: include uv.lock in release workflow commits - #1047

Merged
TomerFi merged 2 commits into
devfrom
fix/release-workflow-uv-lock
Aug 12, 2026
Merged

fix: include uv.lock in release workflow commits#1047
TomerFi merged 2 commits into
devfrom
fix/release-workflow-uv-lock

Conversation

@TomerFi

@TomerFi TomerFi commented Aug 12, 2026

Copy link
Copy Markdown
Owner

Problem

The pages workflow (GH-Pages deploy) fails on release tags with:

error: The lockfile at `uv.lock` needs to be updated, but `--locked` was provided.

Root cause

uv version --bump updates both pyproject.toml and uv.lock — uv bakes the project version into the lockfile. However, the release workflow only committed pyproject.toml and mkdocs.yml, discarding the lockfile update. The release tag therefore has a stale lockfile that doesn't match pyproject.toml.

Fix

Add uv.lock to both git add commands in the release workflow:

  1. Line 111 (release version bump): pyproject.tomlmkdocs.ymluv.lock
  2. Line 175 (dev version bump): pyproject.tomluv.lock

Summary by CodeRabbit

  • Chores
    • Release updates now include the project’s lock file alongside version changes, helping keep published and development releases consistent.

…are preserved

- uv version --bump updates both pyproject.toml and uv.lock
- the first commit only added pyproject.toml and mkdocs.yml
- the second commit only added pyproject.toml
- lockfile changes were being discarded, causing pages workflow to fail on release tags
- both commits now include uv.lock
@sourcery-ai

sourcery-ai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR updates the release GitHub Actions workflow so that uv.lock is committed alongside pyproject.toml (and mkdocs.yml where applicable), ensuring the lockfile version stays in sync with the project version during release and post-release dev bumps.

File-Level Changes

Change Details Files
Ensure release workflow commits uv.lock whenever the project version is bumped so the lockfile stays consistent with pyproject.toml.
  • Update the release-tag bump step to include uv.lock in the git add command along with pyproject.toml and mkdocs.yml.
  • Update the post-release dev-version bump step to include uv.lock in the git add command along with pyproject.toml.
.github/workflows/release.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@snyk-io

snyk-io Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Test Results

69 tests   69 ✅  1s ⏱️
 1 suites   0 💤
 1 files     0 ❌

Results for commit 518b296.

♻️ This comment has been updated with latest results.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 9bc8e9e2-56f1-4ff5-99c7-64b030b022dc

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 09bc45b9-03a5-4602-9157-d602a30aaa99

📥 Commits

Reviewing files that changed from the base of the PR and between 5ba73f0 and 0dcea6f.

📒 Files selected for processing (1)
  • .github/workflows/release.yml

Walkthrough

The release workflow now stages uv.lock with pyproject.toml during release-version and development-version commits.

Changes

Release workflow

Layer / File(s) Summary
Stage lockfile with version updates
.github/workflows/release.yml
The release and development version commit steps now stage uv.lock alongside pyproject.toml.

Suggested reviewers: dmatik, yogevbokobza

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding uv.lock to release workflow commits.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/release-workflow-uv-lock

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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai
coderabbitai Bot requested review from YogevBokobza and dmatik August 12, 2026 17:06
@codecov

codecov Bot commented Aug 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.07%. Comparing base (3a9ddbe) to head (518b296).
⚠️ Report is 2 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #1047   +/-   ##
=======================================
  Coverage   96.07%   96.07%           
=======================================
  Files           1        1           
  Lines         331      331           
=======================================
  Hits          318      318           
  Misses         13       13           

☔ 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.

@TomerFi
TomerFi merged commit 2c54720 into dev Aug 12, 2026
10 checks passed
@TomerFi
TomerFi deleted the fix/release-workflow-uv-lock branch August 12, 2026 17:15
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.

1 participant