From ba750deec95df77b7f0819e18fa02acbb52cecdf Mon Sep 17 00:00:00 2001 From: Eliah Kagan Date: Fri, 13 Oct 2023 17:15:16 -0400 Subject: [PATCH] Update readme for milestone-less releasing --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index b9e61912a..b567d49a2 100644 --- a/README.md +++ b/README.md @@ -199,13 +199,12 @@ Please have a look at the [contributions file][contributing]. ### How to make a new release - Update/verify the **version** in the `VERSION` file. -- Update/verify that the `doc/source/changes.rst` changelog file was updated. +- Update/verify that the `doc/source/changes.rst` changelog file was updated. It should include a link to the forthcoming release page: `https://github.com/gitpython-developers/GitPython/releases/tag/` - Commit everything. - Run `git tag -s ` to tag the version in Git. - _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`.\ (When run in a virtual environment, the next step will automatically take care of installing `build` and `twine` in it.) - Run `make release`. -- Close the milestone mentioned in the _changelog_ and create a new one. _Do not reuse milestones by renaming them_. - Go to [GitHub Releases](https://github.com/gitpython-developers/GitPython/releases) and publish a new one with the recently pushed tag. Generate the changelog. ### How to verify a release (DEPRECATED)