Skip to content

CI: Update Release workflow for LocalStack Python SDK #20

Open
aidehn wants to merge 1 commit intomainfrom
aidehn/fix/python-sdk-release-workflow
Open

CI: Update Release workflow for LocalStack Python SDK #20
aidehn wants to merge 1 commit intomainfrom
aidehn/fix/python-sdk-release-workflow

Conversation

@aidehn
Copy link
Copy Markdown

@aidehn aidehn commented Apr 29, 2026

Changes + Motivation

  • Noticed that the workflow was not publishing to PyPi with the correct version - this is a result of make install altering the uv.lock file and hence inferring the published version incorrectly.
    • Since the commit it is published from is tagged with the exact version, e.g. v2026.4.0, the version inferred by setuptools_scm should be 2026.4.0 but since there were changes made to the uv.lock file it was instead inferred as v2026.4.1.dev0 which is not the version we want published.
  • Updated the workflow to instead run make publish instead of make install publish as @giograno identified it was a result of running make install.
  • Updated the workflow to also no longer use the release helper as it was still using an older version, but also it didn't need to use it for simple git commands.
  • Agreed with @giograno to remove the development versions being published to PyPi and so, also the development commits being pushed.

@aidehn aidehn requested review from alexrashed and giograno April 29, 2026 11:18
@aidehn aidehn marked this pull request as draft April 29, 2026 11:19
@aidehn aidehn self-assigned this Apr 29, 2026
@aidehn aidehn marked this pull request as ready for review April 29, 2026 11:49
Copy link
Copy Markdown
Member

@giograno giograno left a comment

Choose a reason for hiding this comment

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

Thanks for tackling this!
I have only a minor question about the uv.lock file. Maybe @alexrashed has some suggestions.

git config user.email ${{ env.git_user_email }}

- name: "Commit changed code"
- name: "Commit Changed Code"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I am wondering if we should try to commit the uv.lock file here as well. It's true that we won't get the same issue anymore downstream, but maybe it's good to keep it updated.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not sure I understand / have the full context here.
Does the pyproject.toml change here? If so, then the uv.lock file definitely needs to be updated (without upgrading the dependencies in there) and commited.

Everything else (like upgrading the versions in the uv.lock) should in my opinion not be part of the release workflow (way too fragile!), but should rather be handled with weekly updates proposed by dependabot (or any other kind of automation).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

But I am still not sure if I understood this correctly, also happy to jump on a huddle to discuss this directly / look at this together.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

No pyproject.toml wouldn't change here. In the previous releases, we first tagged the release commit and then ran make install publish. uv.lock was unstaged, and this resulted in a dev version being pushed to PyPi. This should not happen anymore, but I was wondering when is a good time to commit an update to uv.lock. As you suggested, some sort of automation would be the best.

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.

3 participants