42acf8c792a8df5fa3c986fc7810d954c45ea6a6
[vlc.git] / doc / release-howto.txt
1 Release HOWTO
2 -------------
3
4 [ Note: this howto is probably useful to core vlc developers only ]
5
6  * Tests: compilation, regression tests ...
7
8  * Changes on the git repository
9    - Check that the version number everywhere it's needed
10      · configure.ac
11      · NEWS
12    - Update important things and add them to the NEWS file
13    - Close the milestone on Trac https://trac.videolan.org/vlc
14    - Update OpenGPG key embedded in include/vlc_update.h if needed
15    - Increase the libvlccore and libvlc revisions in src/Makefile.am
16       _if_and_only_if_ the ABI number has not been increased instead, in
17       which case the revision goes back to zero.
18
19  * Commit
20  * "Tag" the release
21     git tag -a -m "VLC Release VERSION" <VERSION>
22     (Create an annotated tag, you can skip -a if you used -m)
23     git push origin <VERSION>
24
25  * Tarballs (Use a clean tree !!!)
26   - Use 'make distcheck' to make sure all files are exported correctly
27   - copy the tar.xz file on ganesh.videolan.org
28   - generate SHA, MD5 hashes and OpenPGP signature of these files
29     (use sha*sum --binary, md5sum --binary, gpg -u VideoLAN\ Release --sign --detach --armor)
30     Use the sumandsign.sh script
31
32  * Contribs
33   - Put a copy of the libraries or git snapshot in ftp://ftp.videolan.org/pub/contrib/
34   - Put the relevant win32 and Mac OS contrib package
35   - Update s.v.o/vlc and www.v.o/vlc/download-sources.html
36
37  * Win32 Packages
38   - configure using the extras/package/win32/configure.sh script
39   - copy the packages files on ganesh.videolan.org
40   - copy the vlc-2.0.4 and symbols-2.0.4 to balthazar for stacktraces
41
42  * Mac OS X packages
43   - configure using the extras/package/macosx/configure.sh script
44   - use extras/package/macosx/codesign.sh with options and key to sign it.
45   - copy the package to ganesh.videolan.org
46
47  * Sign all the files and move the signed files on /opt/ftp/pub/videolan/vlc/X.X.X
48   - At first block access to this directory by http or ftp. Only authorize rsync.
49     This is to avoid leak as some journalists and forums seem to watch the ftp.
50   - Update the "last" symlink
51
52  * Update the website
53   - edit the /index.php /vlc/*.php, include/os-specific.php files
54   - create a /vlc/release/X.X.X page
55   - add a news item to news.msg
56   - update the front page OS dependant screenshots if the interface changed.
57   - update the md5
58
59  * "Check for updates" functionality
60   - edit update.videolan.org/vlc/status
61   - gpg -u VideoLAN\ Release -t --sign --detach --armor
62   - for i in *asc;do gpg --verify $i || echo $i;done
63
64  * Mirrors
65   - Forwarn the mirror admins (optional for any minor release)
66   - Go to https://get.videolan.org/<path-to-the-file>?mirrorlist
67   - Ensures there is enough mirrors able to serve the file in each region
68     or just wait few more hours before doing the release.
69     Suggested number of mirrors:
70         - > 70% for a minor release
71         - > 80% for a major release
72         - > 80% for any auto-update
73   - Keep an eye on https://get.videolan.org/?mirrorstats during the release
74
75  * Update the wiki
76   - edit http://wiki.videolan.org/Template:VLC:latest_version
77
78  * Announce on www.freecode.com (let jb or sam do it, if you lack the account)
79   - go to https://freecode.com/projects/vlc/
80   - chose "Submit a release" in the right menu, in "Administration"
81   - Do the steps and wait (the update can take several hours)
82
83  * Announce on Twitter, Facebook and G+
84   Unfortunately, those are more followed than the all other mediums combined
85
86  * Announce email and forum topic
87   - Write something along the lines of previous releases
88   - Post in videolan-announce (moderated), vlc et vlc-devel
89     You are advised to add the author list for this version using
90     'git shortlog -s PREVIOUS_VERSION..VERSION'
91     And to add git diff --stat PREVIOUS_VERSION..VERSION if it's relevant.
92     You can play a bit with git to show the piece of information that may be
93     interesting.
94   - Add a sticky thread in the "General VLC media player discussion" forum
95