diff options
| author | Jack Lloyd <[email protected]> | 2017-08-29 17:10:11 -0400 |
|---|---|---|
| committer | Jack Lloyd <[email protected]> | 2017-08-29 17:10:11 -0400 |
| commit | f0e43647d10cdc5a8dbb93907c4967c884ffa1ce (patch) | |
| tree | feded246d8dd39f228b56035dd4e53b59e5fd375 | |
| parent | 3cd661c8dc45f4c05c49cbfa09301d118d2cbb77 (diff) | |
Add a reminder to test with valgrind etc before release
Would have avoided 3cd661c8dc
| -rw-r--r-- | doc/release_process.rst | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/doc/release_process.rst b/doc/release_process.rst index 603a46a27..f71f1822d 100644 --- a/doc/release_process.rst +++ b/doc/release_process.rst @@ -6,6 +6,21 @@ Release Process and Checklist This information is only useful if you are a developer of botan who is creating a new release of the library. +Pre Release Testing +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Kick off a Coverity scan a day or so before the planned release. + +And remember that CI doesn't test everything. In particular, not all +tests run under valgrind or on the qemu cross builds due to time +constraints. So before release, do a complete build/test cycle: + + - Running under valgrind (remember `--with-valgrind` flag) + - Using Clang sanitizers (ASan + UbSan) + - Native or cross compile for Linux aarch64 and ppc64le + - Native compile on FreeBSD x86-64 + - Native compile on at least one unusual platform (AIX, NetBSD, ...) + Pre Release Checks ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -17,7 +32,7 @@ release. 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 git (eg tag '1.11.8', no prefix). +tag the release with the version in git (eg tag '2.6.13', no prefix). Build The Release Tarballs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -25,7 +40,7 @@ Build The Release Tarballs The release script is ``src/scripts/dist.py`` and must be run from a git workspace. - $ src/scripts/dist.py 1.11.18 + $ src/scripts/dist.py 2.6.13 One useful option is ``--output-dir``, which specifies where the output will be placed. @@ -51,7 +66,7 @@ placed in ``build/botan.iss`` by ``configure.py``. Create the installer either via the InnoSetup GUI by opening the ``iss`` file and selecting the 'Compile' option, or using the ``iscc`` command line tool. If all goes well it will produce an executable with a name like -``botan-1.11.18-x86_64.exe``. Sign the installers with GPG. +``botan-2.6.13-x86_64.exe``. Sign the installers with GPG. Update The Website ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |