From 38bd1bfd6d6e08bb4dc87edcaa2657d293a4560c Mon Sep 17 00:00:00 2001 From: Ben Sturmfels Date: Tue, 30 Mar 2021 16:15:58 +1100 Subject: [PATCH] docs: Add a draft release checklist. --- docs/source/devel/release.rst | 23 +++++++++++++++++++++++ docs/source/index.rst | 1 + 2 files changed, 24 insertions(+) create mode 100644 docs/source/devel/release.rst diff --git a/docs/source/devel/release.rst b/docs/source/devel/release.rst new file mode 100644 index 00000000..f18ceabc --- /dev/null +++ b/docs/source/devel/release.rst @@ -0,0 +1,23 @@ +================= +Release Checklist +================= + +- update docs/sources/siteadmin/relnotes.txt +- update docs/sources/siteadmin/upgrading.txt +- write a blog post +- update mediagoblin/_version.py +- update configure.ac version +- test the upgrade process +- build the docs and check they look good +- git tag v0.11.0 --signed +- push tags +- log in and rebuild master and new version docs on readthedocs.org +- merge into stable branch? +- update mediagoblin/_version.py again to add ".dev" suffix +- update configure.ac version again to add ".dev" suffix + +Do we even need a stable branch? I'm not entirely happy with the upgrade +instructions "git fetch && git checkout -q v0.11.0 && git submodule update". Why +have a stable branch if you're asking them to checkout a particular tag anyway? + +What to do if you've pushed a tag and the docs need updating? diff --git a/docs/source/index.rst b/docs/source/index.rst index b6928d59..50897cd6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -95,6 +95,7 @@ This chapter contains various information for developers. devel/codebase devel/storage + devel/release devel/originaldesigndecisions devel/migrations