aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2018-01-05 14:50:27 -0500
committerJack Lloyd <[email protected]>2018-01-05 14:51:59 -0500
commit6af53b3f668bd82bbf454703c0e15590c447254c (patch)
treee5c34b41608cfe81e7226a4dc785ec1387294bd9 /doc
parent8f404e5ca5348a816a6ae54d7a13d2636bf36760 (diff)
Document how the website is updated [ci skip]
Diffstat (limited to 'doc')
-rw-r--r--doc/release_process.rst27
1 files changed, 24 insertions, 3 deletions
diff --git a/doc/release_process.rst b/doc/release_process.rst
index f20713d4f..73565a02e 100644
--- a/doc/release_process.rst
+++ b/doc/release_process.rst
@@ -39,8 +39,8 @@ tag the release with the version in git (eg tag '2.6.13', no prefix).
Build The Release Tarballs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The release script is ``src/scripts/dist.py`` and must be
-run from a git workspace.
+The release script is ``src/scripts/dist.py`` and must be run from a
+git workspace.
$ src/scripts/dist.py 2.6.13
@@ -54,6 +54,19 @@ which is the official signing key. You can use ``--pgp-key-id=none``
to avoid creating any signature, though official distributed releases
*should not* be released without signatures.
+The releases served on the official site are taken from the contents
+in a git repository::
+
+ $ git checkout [email protected]:/srv/git/botan-releases.git
+ $ src/scripts/dist.py 2.6.13 --output-dir=botan-releases
+ $ cd botan-releases
+ $ sha256sum Botan-2.6.13.tgz >> sha256sums.txt
+ $ git add .
+ $ git commit -m "Release version 2.6.13"
+ $ git push origin master
+
+A cron job updates the live site every 10 minutes.
+
Build The Windows Installer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -74,7 +87,15 @@ Update The Website
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The website content is created by ``src/scripts/website.py``.
-Currently refreshing the website is a manual process.
+
+The website is mirrored automatically from a git repository which must be updated::
+
+ $ git checkout [email protected]:/srv/git/botan-website.git
+ $ ./src/scripts/website.py --output botan-website
+ $ cd botan-website
+ $ git add .
+ $ git commit -m "Update for 2.6.13"
+ $ git push origin master
Announce The Release
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^