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

Switch to hatch-vcs for versioning #4802

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

vidipsingh
Copy link
Contributor

Description

This PR implements hatch-vcs for versioning, enabling automatic versioning based on Git tags.

Related to: #4742

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python -m pytest (or $ nox -s tests)
  • The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copy link

codecov bot commented Jan 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.69%. Comparing base (5e6678b) to head (3ba901f).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4802   +/-   ##
========================================
  Coverage    98.69%   98.69%           
========================================
  Files          303      303           
  Lines        23258    23258           
========================================
  Hits         22955    22955           
  Misses         303      303           

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

Copy link
Contributor

@kratman kratman left a comment

Choose a reason for hiding this comment

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

Look at the "update_version.py" script in PyBaMM. A bunch of files are updated. For this to work you also need to get the other updated files working for releases.

Files like the change log will still need to be update for each release

@Saransh-cpp Saransh-cpp marked this pull request as draft January 26, 2025 23:24
@vidipsingh
Copy link
Contributor Author

Look at the "update_version.py" script in PyBaMM. A bunch of files are updated. For this to work you also need to get the other updated files working for releases.

Files like the change log will still need to be update for each release

Thanks for the heads-up, @kratman! I'll look into the update_version.py script and other relevant files to ensure everything works properly for releases.

Comment on lines +54 to +55
[tool.hatch.version]
source = "vcs"
Copy link
Member

Choose a reason for hiding this comment

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

Can we move this down to the already existing tool.hatch section?

Suggested change
[tool.hatch.version]
source = "vcs"
[tool.hatch]
version.source = "vcs"
build.hooks.vcs.version-file = "src/pybamm/_version.py"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, I'll move it to the tool.hatch section.

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