Skip to content

Create stable release#99

Merged
yhouyang02 merged 2 commits intomainfrom
otter
Feb 3, 2026
Merged

Create stable release#99
yhouyang02 merged 2 commits intomainfrom
otter

Conversation

@yhouyang02
Copy link
Collaborator

This pull request removes the __version__.py file from the src/wordguess package, which previously contained versioning information and related variables.

  • Removal of versioning metadata:
    • Deleted the src/wordguess/__version__.py file, which included definitions for __version__, version_tuple, and commit_id, as well as type hints and the __all__ list.

@yhouyang02 yhouyang02 added this to the milestone4 milestone Feb 3, 2026
Copilot AI review requested due to automatic review settings February 3, 2026 10:50
@codecov
Copy link

codecov bot commented Feb 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.78%. Comparing base (5f3ced3) to head (65445a2).
⚠️ Report is 9 commits behind head on main.

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

@yhouyang02 yhouyang02 merged commit 4699df4 into main Feb 3, 2026
21 checks passed
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 .gitignore to explicitly ignore src/wordguess/__version__.py instead of the generic _version.py pattern

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__.py file will break the import statement in src/wordguess/__init__.py at 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.

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