Conversation
Update dynamic versioning
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #99 +/- ##
==========================================
+ Coverage 97.67% 98.78% +1.11%
==========================================
Files 11 10 -1
Lines 430 412 -18
Branches 69 68 -1
==========================================
- Hits 420 407 -13
+ Misses 6 2 -4
+ Partials 4 3 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This pull request attempts to remove the auto-generated __version__.py file from version control and update the .gitignore file to prevent tracking it in the future. However, the PR title "Create stable release" is misleading as these changes do not actually create a release.
Changes:
- Deletion of
src/wordguess/__version__.py(an auto-generated file by hatch-vcs) - Update to
.gitignoreto explicitly ignoresrc/wordguess/__version__.pyinstead of the generic_version.pypattern
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/wordguess/version.py | Removes the auto-generated version file from version control |
| .gitignore | Updates the ignore pattern from generic _version.py to specific src/wordguess/__version__.py |
Comments suppressed due to low confidence (2)
src/wordguess/version.py:1
- Deleting the auto-generated
__version__.pyfile will break the import statement insrc/wordguess/__init__.pyat line 33, which imports__version__from this file. This will cause an ImportError when the package is imported.
The correct approach is to ensure this file is not tracked in version control (which the .gitignore update addresses), but the file itself should continue to be generated by hatch-vcs during the build process. You should not commit the deletion of this file - instead, remove it from version control history if it was previously committed by mistake.
src/wordguess/version.py:1
- The title of this pull request is "Create stable release", but the changes shown do not actually create a stable release. The changes only remove an auto-generated version file from version control and update the .gitignore file. Creating a stable release would typically involve tagging a specific commit with a version number and potentially updating the CHANGELOG.md file.
If the intent is to prepare for a stable release by cleaning up the repository, the PR title should be more specific, such as "Remove auto-generated version.py from version control" or "Fix version file tracking in git".
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This pull request removes the
__version__.pyfile from thesrc/wordguesspackage, which previously contained versioning information and related variables.src/wordguess/__version__.pyfile, which included definitions for__version__,version_tuple, andcommit_id, as well as type hints and the__all__list.