aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source
diff options
context:
space:
mode:
authorBen Sturmfels <ben@sturm.com.au>2021-03-30 16:15:58 +1100
committerBen Sturmfels <ben@sturm.com.au>2021-03-30 16:17:04 +1100
commit38bd1bfd6d6e08bb4dc87edcaa2657d293a4560c (patch)
tree38666debe1829343eab95e91fca4c2baed8f56f8 /docs/source
parent327a378f7085e7a0adac72fb5cb6907e50186970 (diff)
downloadmediagoblin-38bd1bfd6d6e08bb4dc87edcaa2657d293a4560c.tar.lz
mediagoblin-38bd1bfd6d6e08bb4dc87edcaa2657d293a4560c.tar.xz
mediagoblin-38bd1bfd6d6e08bb4dc87edcaa2657d293a4560c.zip
docs: Add a draft release checklist.
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/devel/release.rst23
-rw-r--r--docs/source/index.rst1
2 files changed, 24 insertions, 0 deletions
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