From 16656c4c9e9facd9c1caba982247302e6f5e1949 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Mon, 26 Nov 2018 20:41:14 +0100 Subject: [PATCH] Update the release process documentation --- docs/release-process.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/release-process.md b/docs/release-process.md index 17bb23ea..91e338c3 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -8,11 +8,11 @@ When enough changes have accumulated, it is time to release new version of Catch These steps are necessary and have to be performed before each new release. They serve to make sure that the new release is correct and linked-to from the standard places. -### Approval testing +### Testing -Catch's releases are primarily validated against output from previous release, stored in `projects/SelfTest/Baselines`. To validate current sources, build the SelfTest binary and pass it to the `approvalTests.py` script: `approvalTests.py `. - -There should be no differences, as Approval tests should be updated when changes to Catch are made, but if there are, then they need to be manually reviewed and either approved (using `approve.py`) or Catch requires other fixes. +All of the tests are currently run in our CI setup based on TravisCI and +AppVeyor. As long as the last commit tested green, the release can +proceed. ### Incrementing version number @@ -27,7 +27,7 @@ version numbers everywhere and pushing the new version to Wandbox. ### Release notes -Once a release is ready, release notes need to be written. They should summarize changes done since last release. For rough idea of expected notes see previous releases. Once written, release notes should be placed in `docs/release-notes.md`. +Once a release is ready, release notes need to be written. They should summarize changes done since last release. For rough idea of expected notes see previous releases. Once written, release notes should be added to `docs/release-notes.md`. ### Commit and push update to GitHub @@ -46,9 +46,5 @@ it should use linux line endings. All non-bundled reporters (Automake, TAP, TeamCity) should also be attached as binaries, as they might be dependent on a specific version of the single-include header. -Since 2.5.0 the released "binaries" (headers) should be PGP signed. - -## Optional steps - -Because Catch2's [vcpkg](https://github.com/Microsoft/vcpkg) port updates -itself automagically, there are no optional steps at this time. +Since 2.5.0, the release tag and the "binaries" (headers) should be PGP +signed.