Revert "Allow the examples to build with --disable-http"
[opusfile.git] / doc / release.txt
1 = Release checklist =
2
3 Source release:
4
5 - Update OP_LT_* API versioning in configure.ac.
6 - Check for uncommitted changes to master.
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 packge 'opusfile-${version}.tar.gz'
13   to website and verify file permissions.
14 - Update checksum files on website.
15 - Update links on <http://www.opus-codec.org/downloads/>.
16 - Add a copy of the documentation to <http://www.opus-codec.org/docs/>
17   and update the links.
18
19 Releases are commited to https://svn.xiph.org/releases/opus/
20 which propagates to downloads.xiph.org, and copied manually
21 to https://ftp.mozilla.org/pub/mozilla.org/opus/
22
23 Win32 binaries:
24
25 - Assuming the mingw cross toolchain:
26 - Checkout/download latest or other appropriate
27   versions of libogg, opus, and any other supported
28   dependencies.
29 - Compile them with:
30     ./configure --host=i686-w64-mingw32 --prefix=/path/to/builddir
31     make && make check && make install
32   or similar. Wine is required for 'make check' to complete.
33 - Compile opusfile with:
34     ./configure --host=i686-w64-mingw32 --prefix=/path/to/builddir \
35         PKG_CONFIG_PATH=/path/to/builddir/lib/pkgconfig
36     make && make check && make -C doc/latex
37 - mkdir opusfile-${version}-win32
38 - Copy AUTHORS COPYING README.txt include/opusfile.h to the release dir.
39 - Merge changes between README.txt and the version in the last
40   binary release. E.g. it's good to include versions of the dependencies,
41   release notes, etc.
42 - Convert README.txt to DOS line endings.
43 - Copy .libs/libopusfile-0.dll to the release dir.
44 - Copy .libs/libopusfile.a to the release dir.
45 - Copy .libs/libopusfile.dll.a to the release dir. (May not be needed?)
46 - Copy libogg/src/.libs/libogg-0.dll to the release dir.
47 - Copy opus/.libs/libopus-0.dll to the release dir.
48 - Copy any other dependent dlls
49 - Copy doc/latex/refman to opusfile-${version}-win32/opusfile-${version}.pdf
50 - Copy examples/.libs/*.exe to the release dir.
51 - Strip *.dll *.a *.exe in the release dir.
52 - In the release dir, run:
53     sha1sum * > SHA1SUMS.txt
54     gpg --detact-sign --armor SHA1SUMS.txt
55 - In the parent directory, create the archive:
56     zip -r opusfile-${version}-win32.zip opusfile-${version}-win32/*
57 - Copy the archive to a clean system and verify the examples work
58   to make sure you've included all the necessary libraries.
59 - Upload the archive zipfile to websites.
60 - Verify file permissions and that it's available at the expected
61   URL.
62 - Update links on <http://www.opus-codec.org/downloads/>.
63
64 Binary releases are copied manually to
65 ftp.mozilla.org:/pub/mozilla.org/opus/win32/