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

Add uv.lock to gitattributes #695

Merged
merged 2 commits into from
Mar 26, 2025
Merged

Add uv.lock to gitattributes #695

merged 2 commits into from
Mar 26, 2025

Conversation

NicolaCourtier
Copy link
Member

@NicolaCourtier NicolaCourtier commented Mar 26, 2025

Description

Hide changes to the auto-generated uv.lock file by default.

Issue reference

Show fix

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

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 unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

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

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

Hi @NicolaCourtier, I would suggest not ignoring uv.lock in version control – it's generally recommended to include it in version control for reproducibility (as the comment you added is saying). If you're looking to reduce the increased diff on PRs generated when the lockfile is changed, you could add

uv.lock linguist-generated=true

to the .gitattributes file, which will make GitHub not show the diff automatically unless you prompt it to.

Copy link

codecov bot commented Mar 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.21%. Comparing base (df79ec2) to head (deff4b7).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #695   +/-   ##
========================================
  Coverage    99.21%   99.21%           
========================================
  Files           67       67           
  Lines         4842     4842           
========================================
  Hits          4804     4804           
  Misses          38       38           

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

@NicolaCourtier
Copy link
Member Author

Thanks for the advice @agriyakhetarpal !

@NicolaCourtier NicolaCourtier changed the title Add uv.lock to gitignore Add uv.lock to gitattributes Mar 26, 2025
Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

Thanks, @NicolaCourtier!

You can see that this works now, on https://github.com/pybop-team/PyBOP/pull/695/files :)

@NicolaCourtier NicolaCourtier merged commit 74300d0 into develop Mar 26, 2025
31 checks passed
@NicolaCourtier NicolaCourtier deleted the gitignore-uvlock branch March 26, 2025 16:22
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.

2 participants