Repository navigation
Commit 5343aa0
committed
Let "make" install build and twine if in a virtual environment
If a virtual environment (created by venv or virtualenv) is active,
running "make release" or "make force_release" now automatically
installs/upgrades the "build" and "twine" packages in it. This is
only done if "make" is run in a virtual environment.
This can be a fresh environment: neither the project nor its
dependencies need to be installed in it. Because the "build" module
is not currently used in any tests and running "make" in a virtual
environment takes care of installing "build" (and "twine"), "build"
is now removed from test-requirements.txt.
The publishing instructions in the readme are updated accordingly,
to mention the optional step of creating and activating a virtual
environment, and to briefly clarify why one might want to do that.
Running "make" outside a virtual environment remains supported,
except that, due to recent changes, whatever environment it is run
in needs to have a usable "build" module.1 parent f86f09e commit 5343aa0
3 files changed
Lines changed: 10 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -15,6 +15,8 @@ release: clean | |||
| 15 | 15 | make force_release | |
| 16 | 16 | ||
| 17 | 17 | force_release: clean | |
| 18 | + # IF we're in a virtual environment, add build tools | ||
| 19 | + test -z "$$VIRTUAL_ENV" || pip install -U build twine | ||
| 18 | 20 | python3 -m build --sdist --wheel | |
| 19 | 21 | twine upload dist/* | |
| 20 | 22 | git push --tags origin main | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -188,13 +188,15 @@ Please have a look at the [contributions file][contributing]. | |||
| 188 | 188 | ||
| 189 | 189 | ### How to make a new release | |
| 190 | 190 | ||
| 191 | - - Update/verify the **version** in the `VERSION` file | ||
| 192 | - - Update/verify that the `doc/source/changes.rst` changelog file was updated | ||
| 193 | - - Commit everything | ||
| 194 | - - Run `git tag -s <version>` to tag the version in Git | ||
| 195 | - - Run `make release` | ||
| 191 | + - Update/verify the **version** in the `VERSION` file. | ||
| 192 | + - Update/verify that the `doc/source/changes.rst` changelog file was updated. | ||
| 193 | + - Commit everything. | ||
| 194 | + - Run `git tag -s <version>` to tag the version in Git. | ||
| 195 | + - _Optionally_ create and activate a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment) using `venv` or `virtualenv`.\ | ||
| 196 | + (When run in a virtual environment, the next step will automatically take care of installing `build` and `twine` in it.) | ||
| 197 | + - Run `make release`. | ||
| 196 | 198 | - Close the milestone mentioned in the _changelog_ and create a new one. _Do not reuse milestones by renaming them_. | |
| 197 | - - Got to [GitHub Releases](https://github.com/gitpython-developers/GitPython/releases) and publish a new one with the recently pushed tag. Generate the changelog. | ||
| 199 | + - Go to [GitHub Releases](https://github.com/gitpython-developers/GitPython/releases) and publish a new one with the recently pushed tag. Generate the changelog. | ||
| 198 | 200 | ||
| 199 | 201 | ### How to verify a release (DEPRECATED) | |
| 200 | 202 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,5 +1,4 @@ | |||
| 1 | 1 | black | |
| 2 | - build | ||
| 3 | 2 | coverage[toml] | |
| 4 | 3 | ddt>=1.1.1, !=1.4.3 | |
| 5 | 4 | mypy | |
0 commit comments