doc: update developer manual release steps

Update the release steps in the developer manual to mention the
requirement for a GnuPG key, emphasize the editing the changelog step
and add instructions for putting `signtool.exe` in the `PATH` for the 32
bit Windows binary.

Signed-off-by: Rafael Kitover <rkitover@gmail.com>
This commit is contained in:
Rafael Kitover 2024-09-09 10:10:13 +00:00
parent 7f49cd33ad
commit 90867bc802
No known key found for this signature in database
GPG Key ID: 08AB596679D86240
1 changed files with 15 additions and 0 deletions

View File

@ -199,6 +199,14 @@ Pass `-DCMAKE_BUILD_TYPE=Debug` to cmake.
### Release Process ### Release Process
#### GnuPG Key
You will need to create a GnuPG key for signing your commits and release tags,
and upload it to a keyserver.
Make sure to install GnuPG on all environments where you will be making commits
and tags.
#### Certificates #### Certificates
Make sure you have set up a Windows code signing certificate with the right Make sure you have set up a Windows code signing certificate with the right
@ -216,6 +224,9 @@ cmake .. -DTAG_RELEASE=TRUE
``` ```
, follow the instructions to edit the `CHANGELOG.md` and then push the release: , follow the instructions to edit the `CHANGELOG.md` and then push the release:
To reiterate, **make sure you edit the `CHANGELOG.md`** to remove any
non-user-facing changes before you make the release commit.
```bash ```bash
git push git push
git push --tags git push --tags
@ -257,6 +268,10 @@ The 32-bit build is a legacy build for Windows XP compatibility. You will need
the MinGW toolchain to build it. The easiest method is to use the MINGW32 MSYS2 the MinGW toolchain to build it. The easiest method is to use the MINGW32 MSYS2
environment. environment.
Make sure the Visual Studio `signtool.exe` is in your path, you can start MSYS2
with an inherited `PATH` from a Visual Studio enabled environment or add it to
your shell configuration.
First install dependencies with: First install dependencies with:
```bash ```bash