From ba750deec95df77b7f0819e18fa02acbb52cecdf Mon Sep 17 00:00:00 2001 From: Eliah Kagan Date: Fri, 13 Oct 2023 17:15:16 -0400 Subject: [PATCH 1/3] 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) From a151ea0f66bee8f810b2f93c883a2a0dbad67616 Mon Sep 17 00:00:00 2001 From: Eliah Kagan Date: Fri, 13 Oct 2023 17:53:29 -0400 Subject: [PATCH 2/3] Make the release instructions a numbered list Since they are sequential steps. --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b567d49a2..25d2a910e 100644 --- a/README.md +++ b/README.md @@ -198,14 +198,14 @@ 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. 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`.\ +1. Update/verify the **version** in the `VERSION` file. +2. 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/` +3. Commit everything. +4. Run `git tag -s ` to tag the version in Git. +5. _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`. -- Go to [GitHub Releases](https://github.com/gitpython-developers/GitPython/releases) and publish a new one with the recently pushed tag. Generate the changelog. +6. Run `make release`. +7. 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) From feb4414d955cc76df496f406ae914793028a804e Mon Sep 17 00:00:00 2001 From: Eliah Kagan Date: Fri, 13 Oct 2023 18:01:50 -0400 Subject: [PATCH 3/3] Shorten another step --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 25d2a910e..a7942fd2f 100644 --- a/README.md +++ b/README.md @@ -202,8 +202,7 @@ Please have a look at the [contributions file][contributing]. 2. 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/` 3. Commit everything. 4. Run `git tag -s ` to tag the version in Git. -5. _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.) +5. _Optionally_ create and activate a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment). (Then the next step can install `build` and `twine`.) 6. Run `make release`. 7. Go to [GitHub Releases](https://github.com/gitpython-developers/GitPython/releases) and publish a new one with the recently pushed tag. Generate the changelog.