Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: properly manage pyproject.toml version #325

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

chanind
Copy link
Collaborator

@chanind chanind commented Oct 8, 2024

Description

Our previous semantic release setup updates the pyproject.toml:version variable. However, this also has the unintended side-effect of replacing any version = string in pyproject.toml with the new SAELens version. This broke black, since it now has an explicit version = string set, as can be seen here: e2a692a#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R44.

Fortunately, semantic-release has a version_toml option which handles exactly this situation (their example even includes a Poetry pyproject.toml).

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have not rewritten tests relating to key interfaces which would affect backward compatibility

You have tested formatting, typing and unit tests (acceptance tests not currently in use)

  • I have run make check-ci to check format and linting. (you can run make format to format code if needed.)

Copy link

codecov bot commented Oct 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.43%. Comparing base (5e70edc) to head (f11a55c).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #325   +/-   ##
=======================================
  Coverage   62.43%   62.43%           
=======================================
  Files          25       25           
  Lines        3144     3144           
  Branches      550      550           
=======================================
  Hits         1963     1963           
  Misses       1077     1077           
  Partials      104      104           

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

@chanind
Copy link
Collaborator Author

chanind commented Oct 8, 2024

Merging as CI is currently broken and this should be fairly non-controversial

@chanind chanind merged commit 432df87 into main Oct 8, 2024
7 checks passed
@chanind chanind deleted the fix-semantic-release-version-overwrite branch October 8, 2024 14:18
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