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