Adding makefile to bump __verion__ at 3 places.#409
Conversation
SB-PawanN
requested review from
tomlongridge and
twometresteve
and removed request for
Copilot
|
Note that the main intent of the ticket was:
I can see how the changes so far contribute towards that, but the task isn't quite complete without that. Once it's added then you can meaningfully add an "Enhancement" to CHANGELOG.md for it. |
|
When is the maintainer expected to run |
Yes - we need to update that instruction. Note that this works differently to the other bump scripts which take a parameter and update all the files. |
SB-PawanN
force-pushed
the
Pawan/PLAT-5521--version--
branch
from
fb4978a to
aa18195
Compare
This implements the requested feature to expose bugsnag.__version__ for programmatic version checking, as per PEP 396. Changes: - Created VERSION file containing current version (4.8.0) - Updated bugsnag/__init__.py to read from VERSION and expose __version__ - Updated setup.py to read version from VERSION file - Updated bugsnag/notifier.py to read version from VERSION file - Added MANIFEST.in to include VERSION in package distributions - Updated CHANGELOG.md with enhancement entry - Updated CONTRIBUTING.md to document simplified release process Benefits: - Single source of truth for version number (no more manual updates in 3 places) - bugsnag.__version__ now available for programmatic access - Graceful fallback to 'unknown' if VERSION file is missing
SB-PawanN
force-pushed
the
Pawan/PLAT-5521--version--
branch
from
aa18195 to
f8a1284
Compare
|
I've completely revised this PR based on your feedback. The previous Makefile approach has been replaced with a cleaner VERSION file solution. Previous approach:
New approach:
Ready for review! |
Implements bugsnag.__version__ for programmatic version checking (PEP 396). Uses Makefile approach (inspired by bugsnag-cocoa) to address performance concerns. Changes: - Added __version__ = '4.8.0' to bugsnag/__init__.py - Hardcoded version='4.8.0' in setup.py - Hardcoded 'version': '4.8.0' in bugsnag/notifier.py - Added Makefile with bump target for automated version updates - Updated CHANGELOG.md with enhancement entry - Updated CONTRIBUTING.md to document Makefile usage - Removed VERSION file and MANIFEST.in (no runtime file I/O overhead) - Updated features/support/env.rb (removed VERSION from test fixtures) Usage: - Users: bugsnag.__version__ returns '4.8.0' - Maintainers: make VERSION=x.y.z bump (updates all 3 files) Benefits: - Zero runtime overhead (no file I/O during import) - bugsnag.__version__ attribute now available - Automated version updates via single Makefile command - Addresses reviewer feedback on performance concerns
tomlongridge
left a comment
tomlongridge
left a comment
There was a problem hiding this comment.
A few comments, but looks good otherwise.
Can you also update the PR description as it's not reflecting your current approach.
| * Add `__version__` attribute for programmatic version checking | ||
| * `bugsnag.__version__` now returns the installed package version | ||
| * Follows PEP 396 specification |
There was a problem hiding this comment.
Let's keep this snappy:
| * Add `__version__` attribute for programmatic version checking | |
| * `bugsnag.__version__` now returns the installed package version | |
| * Follows PEP 396 specification | |
| * Add `bugsnag.__version__` attribute for programmatic version checking as per PEP 396 specification | |
| [#409](https://github.com/bugsnag/bugsnag-python/pull/409) |
Also include the PR link.
| extras_require={ | ||
| 'flask': ['flask', 'blinker'] | ||
| }, | ||
| 'flask': [] |
There was a problem hiding this comment.
What is the purpose of this change?
3 participants
Goal
Implement [bugsnag.version] attribute for programmatic version checking and establish a single source of truth for version management.
Design
VERSION file as the single source of truth. All files ([setup.py], [init.py], [notifier.py]) read from this file. Exposes [bugsnag.version] for programmatic access.
Changeset
Testing
[bugsnag.version] returns '4.8.0'
All unit tests passing (Python 3.5-3.14)
All maze-runner tests passing
44/44 CI checks successful
Impact: New [version] attribute available. Version now managed in one file.