87a19d0e3f8e3349847d90fcd45ba8e534404c5a
[opus.git] / doc / release.txt
1 = Release checklist =
2
3 == Source release ==
4
5 - Check for uncommitted changes to master.
6 - Update OPUS_LT_* API versioning in configure.ac.
7 - Update the version in version.mk
8 - Tag the release commit with 'git tag -s vN.M'.
9  - Include release notes in the tag annotation.
10 - Verify 'make distcheck' produces a tarball with
11   the desired name.
12 - Push tag to public repo.
13 - Upload source package 'opus-${version}.tar.gz'
14  - Add to https://svn.xiph.org/releases/opus/
15  - Update checksum files
16  - svn commit
17  - Copy to archive.mozilla.org/pub/opus/
18  - Update checksum files there as well.
19 - Add release notes to https://svn.xiph.org/websites/opus-codec.org/
20 - Update links and checksums on the downloads page.
21 - Add a copy of the documentation to <https://www.opus-codec.org/docs/>
22   and update the links.
23 - Update /topic in #opus IRC channel.
24
25 Releases are commited to https://svn.xiph.org/releases/opus/
26 which propagates to downloads.xiph.org, and copied manually
27 to https://arcive.mozilla.org/pub/opus/
28
29 Website updates are committed to https://svn.xiph.org/websites/opus-codec.org/
30 which propagates to https://opus-codec.org/
31
32 == Binary release ==
33
34 We usually build opus-tools binaries for MacOS and Windows.
35
36 Binary releases are copied manually to
37 https://archive.mozilla.org/pub/opus/win32/
38
39 For Mac, submit a pull request to homebrew.
40
41 == Website updates ==
42
43 For major releases, recreate the files on https://opus-codec.org/examples/
44 with the next encoder.