Skip to content

Commit 7493057

Browse files
committed
Update changelog; improve README to prevent release mistakes in future.
1 parent c2636d2 commit 7493057

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

‎README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,13 @@ Please have a look at the [contributions file][contributing].
110110

111111
### How to make a new release
112112

113-
* Update/verify the version in the `VERSION` file
114-
* Update/verify that the changelog has been updated
113+
* Update/verify the **version** in the `VERSION` file
114+
* Update/verify that the `doc/source/changes.rst` changelog file was updated
115115
* Commit everything
116116
* Run `git tag -s <version>` to tag the version in Git
117117
* Run `make release`
118-
* Finally, set the upcoming version in the `VERSION` file, usually be
118+
* Close the milestone mentioned in the _changelog_ and create a new one. _Do not reuse milestones by renaming them_.
119+
* set the upcoming version in the `VERSION` file, usually be
119120
incrementing the patch level, and possibly by appending `-dev`. Probably you
120121
want to `git push` once more.
121122

‎doc/source/changes.rst

+6
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
Changelog
33
=========
44

5+
3.0.4 - Bugfixes
6+
=============================================
7+
8+
see the following for details:
9+
https://github.com/gitpython-developers/gitpython/milestone/31?closed=1
10+
511
3.0.3 - Bugfixes
612
=============================================
713

0 commit comments

Comments
 (0)