From 74930577ec77fefe6ae9989a5aeb8f244923c9ac Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 22 Oct 2019 12:47:19 +0200 Subject: Update changelog; improve README to prevent release mistakes in future. --- README.md | 7 ++++--- doc/source/changes.rst | 6 ++++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3734019e..46867a4c 100644 --- a/README.md +++ b/README.md @@ -110,12 +110,13 @@ 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 changelog has been updated +* Update/verify the **version** in the `VERSION` file +* Update/verify that the `doc/source/changes.rst` changelog file was updated * Commit everything * Run `git tag -s ` to tag the version in Git * Run `make release` -* Finally, set the upcoming version in the `VERSION` file, usually be +* Close the milestone mentioned in the _changelog_ and create a new one. _Do not reuse milestones by renaming them_. +* set the upcoming version in the `VERSION` file, usually be incrementing the patch level, and possibly by appending `-dev`. Probably you want to `git push` once more. diff --git a/doc/source/changes.rst b/doc/source/changes.rst index 356056e7..ff5c0459 100644 --- a/doc/source/changes.rst +++ b/doc/source/changes.rst @@ -2,6 +2,12 @@ Changelog ========= +3.0.4 - Bugfixes +============================================= + +see the following for details: +https://github.com/gitpython-developers/gitpython/milestone/31?closed=1 + 3.0.3 - Bugfixes ============================================= -- cgit v1.2.1