From 82a6ceb99e2a92917e2697b7f0928e163d346be2 Mon Sep 17 00:00:00 2001 From: James Lu Date: Thu, 5 Oct 2017 18:20:59 -0700 Subject: [PATCH] docs: Refresh release-process.md [skip ci] --- docs/technical/release-process.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/technical/release-process.md b/docs/technical/release-process.md index 0d34e12..37bb0a0 100644 --- a/docs/technical/release-process.md +++ b/docs/technical/release-process.md @@ -2,16 +2,12 @@ This document documents the steps that I (James) use to release updates to PyLink. -1) Draft the next release & changelog at https://github.com/GLolol/PyLink/releases +1) Draft the next release's changelog in `RELNOTES.md` -2) Copy/export the changelog draft to [RELNOTES.md](../../RELNOTES.md), using a new section. +2) Bump the version in the [`VERSION`](VERSION) file. -- [`export_github_relnotes.py`](https://github.com/GLolol/codescraps/blob/master/utils/export_github_relnotes.py) allows automating this process, using the GitHub API and an optional login to read unpublished drafts. +3) Commit the changes to `VERSION` and `RELNOTES.md`, and tag+sign this commit as the new release. Do not prefix version numbers with "v". -3) Bump the version in the [`VERSION`](VERSION) file. +4) Publish the release via the GitHub release page, using the same changelog content as `RELNOTES.md`. -4) Commit the changes to `VERSION` and `RELNOTES.md`, and tag+sign this commit as the new release. Do not prefix version numbers with "v". - -5) Publish the release via the GitHub release page. - -6) For stable releases, also upload to PyPI: `python3 setup.py sdist upload` +5) For stable releases, ~~also upload to PyPI: `python3 setup.py sdist upload`~~ PyPi uploads are handled automatically via Travis-CI.