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.

Sign up for GitHub

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

Jump to bottom

Generate module version file at build #859

Merged
merged 2 commits into from
Dec 22, 2023
Merged

Generate module version file at build #859

merged 2 commits into from
Dec 22, 2023

Commits on Dec 22, 2023

  1. Generate module version file at build 

    Gunicore rely on `eventlet.__version__` [1], however
this data have been removed during our modernization
of the continuous deployment mechanisms [2].

People reported problem with gunicore after 0.34.1 [3][4],
so, it could be worth to reintroduce similar version info,
to avoid side effects.

This patch propose to use a `hatch-vcs` hook [5] to generate
dynamically, at build, the missing data. Other solutions exists
but each of them have their own problems [6].

Indeed, considering "footgun" described in [6] I choose the
hatch-vcs approach, because, retrieving a wrong version number
during development when the lib is installed in editable mode,
is not, I think, something horrible. I prefer this side effect
rather than relying on another additional underlying library
just to print a version number when eventlet is installed in
editable mode. A new additional requirement which would be
installed anytime at runtime and production.

Moreover, sometimes you want to import a package from a
development repository tarball you just downloaded (where
there's no metadata or Git tags present). So, Using
`setuptools_scm` or `importlib.metadata.version` won't
works in that context.

Fix benoitc/gunicorn#3120

[1] benoitc/gunicorn#3120
[2] eventlet#845
[3] eventlet#845 (comment)
[4] eventlet#842 (comment)
[5] https://github.com/ofek/hatch-vcs#build-hook
[6] https://github.com/maresb/hatch-vcs-footgun-example
    @4383
    4383 committed Dec 22, 2023
    Configuration menu
    Copy the full SHA
    e132577 View commit details
    Browse the repository at this point in the history

  2. _version.py is generated, and therefore shouldn't be checked in.

    @pythonspeed
    pythonspeed committed Dec 22, 2023
    Configuration menu
    Copy the full SHA
    44fee01 View commit details
    Browse the repository at this point in the history