aboutsummaryrefslogtreecommitdiffstats
path: root/doc/release_process.rst
diff options
context:
space:
mode:
authorlloyd <[email protected]>2012-07-10 23:16:52 +0000
committerlloyd <[email protected]>2012-07-10 23:16:52 +0000
commit6760cb17f76fca4d0f521299d4241656a3469e56 (patch)
tree8d806c7f3ffedb8c50f85e807d9f17a4d9e4b39e /doc/release_process.rst
parent4b4c26b1f191a3584371e54e1554b253b6d7bb37 (diff)
More release process docs
Diffstat (limited to 'doc/release_process.rst')
-rw-r--r--doc/release_process.rst35
1 files changed, 22 insertions, 13 deletions
diff --git a/doc/release_process.rst b/doc/release_process.rst
index b3b154322..21d8e6eec 100644
--- a/doc/release_process.rst
+++ b/doc/release_process.rst
@@ -1,18 +1,19 @@
Release Process and Checklist
========================================
-First, check that the release notes under ``doc/relnotes`` are
-accurate and complete. Then update the datestamp in
+.. note::
- * ``readme.txt``
- * ``botan_version.py``
- * ``doc/download.rst``
- * the release notes
+ This information is only useful if you are a developer of botan who
+ is creating a new release of the library.
-checking in all that the version number is also correct. Check in
-these changes (alone, with no other modifications) with a checkin
-message along the lines of "Update for X.Y.Z release", then tag the
-release with the version in monotone (eg tag '1.10.3', no prefix).
+Confirm that the release notes under ``doc/relnotes`` are accurate and
+complete. Then update the datestamp in the release notes and in
+``readme.txt`` and ``botan_version.py`` (also checking that the
+version is correct in those files). Change the entry for the
+appropriate branch in ``doc/download.rst``. Check in these changes
+(alone, with no other modifications) with a checkin message along the
+lines of "Update for X.Y.Z release", then tag the release with the
+version in monotone (eg tag '1.10.3', no prefix).
The release script is ``src/build-data/scripts/dist.py`` and runs from
a monotone repository by pulling the revision matching the tag set
@@ -21,9 +22,8 @@ previously. For instance::
$ src/build-data/scripts/dist.py --mtn-db ~/var/mtn/botan.mtn 1.10.3
The ``--mtn-db`` 'option' is mandatory, unless the environmental
-variable ``BOTAN_MTN_DB`` is set, in which case that value is used
-(unless the option is specified on the command line which overrides
-that value).
+variable ``BOTAN_MTN_DB`` is set, in which case that value is used if
+``--mtn-db`` is not provided.
Another useful option is ``--output-dir``, which specifies where
the output will be placed.
@@ -41,3 +41,12 @@ The current botan website is derived entirely from the ReST content in
called ``mtn-watch`` periodically checks for new updates on the
``net.randombit.botan`` branch (only), and if found regenerates the
site content.
+
+Send an email to the announce and devel mailing lists noting that a
+new release is available.
+
+Immediately after the new release is created, update
+``botan_version.py`` and ``readme.txt`` once again, incrementing the
+version number as appropriate and removing the release dates. For
+release notes, use "Not Yet Released" as the placeholder. For
+``botan_version.py``, use 0.