Update readme for milestone-less releasing by EliahKagan · Pull Request #1707 · gitpython-developers/GitPython (original) (raw)

This updates the release-making instructions in the readme, to release without using milestones and to link to the GitHub release page rather than a milestone, as discussed in #1706.

I've also made those instructions a numbered list, since they consist of sequential steps, and decreased the amount of elaboration in one of the other steps, which I think will make it so the new important details in the changelog-writing step are less likely to be glossed over.

In addition to the changes here, check-version.sh could and, I think, should be extended to check that the top section in changes.rst properly links to the (forthcoming) release page on GitHub. That link contains the version number (rather than a milestone number) so it makes sense for the version check script to validate it. Furthermore, because the page will typically not exist yet, mistakes in the URL may be harder to catch. However, I have not included such a change in this pull request.