diff options
author | Arun Raghavan <arun@asymptotic.io> | 2020-11-27 14:28:33 -0500 |
---|---|---|
committer | Arun Raghavan <arun@asymptotic.io> | 2020-11-27 14:30:53 -0500 |
commit | 6a67b5ba7ebe2a4ac8c0484c43de0435b5d2cf93 (patch) | |
tree | d016b2c3c4a4c0a17984ceb4c314319842be98b1 | |
parent | e5402cd638c316bc544114b5ef13ca8e9c52132b (diff) |
doc: Add some documentation about the release processv1.0
-rw-r--r-- | RELEASING.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..1ffd746 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,61 @@ +# Release process + +## Update the code + +Follow the instructions in `UPDATING.md` to update the code. + +## Update the package version + +If there is no API breakage, update the minor version (X.y -> X.y+1). If there +is API breakage, update the major version (X.y -> X+1.0). + +## Make sure builds are successful on all platforms + +There is CI for `x86_64` and `aarch64` builds, but 32-bit ARM and MIPS builds +need manual verfification (or testing downstream). + +## Tag the release + +Tag the release with: + +```sh +git tag -s -m 'WebRTC AudioProcessing v<X.y>' v<X.y> +``` + +## Make a tarball + +```sh +git archive --format 'tar.gz' \ + --prefix webrtc-audio-processing-X.y -9 vX.y \ + > webrtc-audio-processing-X.y.tar.gz +``` + +## Checksum the tarball + +```sh +sha256sum webrtc-audio-processing-X.y.tar.gz \ + > webrtc-audio-processing-X.y.tar.gz.sha256 +``` + +## Publish the files + +```sh +scp webrtc-audio-processing-*.tar.* \ + annarchy.freedesktop.org:/srv/www.freedesktop.org/www/software/pulseaudio/webrtc-audio-processing/ +``` + +## Push the tag + +```sh +git push origin master +git push origin vX.y +``` + +## Update the website + +This is currently an embarrassing manual process. + +## Send out a release announcement + +This goes to the `pulseaudio-discuss` and `gstreamer-devel` mailing lists, and +possibly `discuss-webrtc` if it seems relevant. |