ChangeLogs are automagically generated
[vlc.git] / doc / release-howto.txt
1 [ Note: this howto is probably useful to core vlc developers only ]
2
3   Release HOWTO
4   -------------
5
6  * Tests : compilation, regression tests ...
7
8  * Changes on the git repository
9    - update the version number everywhere it's needed
10      · configure.ac
11      · extras/MacOSX/vlc.pbprj/project.pbxproj
12      · extras/MacOSX/Resources/English.lproj/InfoPlist.string
13      · read all the commits and add important things to the NEWS file
14      · update the milestones info on https://trac.videolan.org/vlc
15    - Add a note about the matching contrib package in INSTALL.win32
16    - Make sure that the gpg key embedded in include/vlc_update.h is the last one
17
18  * Commit
19
20  * Tarballs (Use a clean tree !!!)
21   - Use 'make distcheck' to make sure all files are exported
22     correctly
23   - copy the tar.gz and tar.bz2 file on ftp.videolan.org in
24     /opt/ftp/pub/videolan/testing/vlc-X.X.X/
25   - generate md5 hashes and gpg signature of these files
26     (use gpg --sign --detach --armor --force-v3-sigs)
27
28  * Contribs
29   - Put a copy of the libraries or git snapshot in vlc-X.X.X/contrib
30   - Put the relevant win32 contrib package
31   - Update developers.v.o/vlc and www.v.o/vlc/download-sources.html
32
33  * BeOS Packages
34     Information on building: http://developers.videolan.org/vlc/beos-compile.html
35     Configure with --enable-update-check
36     Build in the "buildbeos" chroot on altair.
37     # add the .zip files to /opt/ftp/pub/videolan/testing/vlc-X.X.X/beos/
38    generate md5 hashes and gpg signature of these files
39    (use gpg --sign --detach --armor --force-v3-sigs)
40
41  * Win32 Packages
42     make the packages using the nightly builds configure/options/... , don't forget --enable-update-check
43     don't forget to test the installer and uninstaller (the first 0.8.4 uninstaller was broken ...
44     kind of suxxs)
45     add the .zip and .exe files to /opt/ftp/pub/videolan/testing/vlc-X.X.X/win32/
46    generate md5 hashes and gpg signature of these files
47    (use gpg --sign --detach --armor --force-v3-sigs)
48
49  * OS X packages
50    configure with --enable-update-check
51    generate md5 hashes and gpg signature of these files
52    (use gpg --sign --detach --armor --force-v3-sigs)
53
54  * Commit changes ... it never works the first time
55
56  * "Tag" the release
57
58     git tag -a -m "VLC Release VERSION" <VERSION>
59     (Create an annotated tag, you can skip -a if you used -m)
60     git push origin <VERSION>
61
62     (You are advised to play with it on the sandrox.git if you feel unconfortable)
63
64  * Move /opt/ftp/pub/videolan/testing/vlc-X.X.X to /opt/ftp/pub/videolan/vlc/X.X.X
65   - At first block access to this directory by http or ftp. Only authorize rsync.
66     This is to avoid leak as some journalist and forum seems to watch the ftp.
67   - Update the "latest" symlink
68
69  * Update the website
70   - edit the /index.php /vlc/*.php pages
71   - add a news item to news.msg
72
73  * "Check for updates" functionality
74   - add /opt/ftp/pub/videolan/vlc/X.X.X/vlc-X.X.X-announce
75   - edit update.videolan.org/vlc/status.xml
76
77  * Mirrors
78   - Forwarn the mirror admins
79   - Update the list of files for the mirror check (/var/www/local/mirrors.v.o/files)
80   - Disable mirrors which haven't replicated yet and possibly ganesh if enough
81     other mirrors
82
83  * Update wiki
84   - edit http://wiki.videolan.org/Template:VLC:latest_version
85
86  * Announce on www.gnome.org
87   - click on "Get more software"
88   - click on "Edit an existing map entry"
89   - look for the 'vlc' package
90   - update the version number and other info and submit
91   - the change is instantaneaous
92
93  * Announce on www.freshmeat.net (let sam do it)
94   - you need a freshmeat account
95   - go to http://www.freshmeat.net/projects/vlc/
96   - click on the release's branch (ie Stable)
97   - chose "add release" in the dropdown menu
98   - fill out all the info and submit
99   - the update can take several hours
100
101  * Announce on VersionTracker
102   - ask Meuuh
103
104  * Announce email
105   - write something along the lines of previous releases
106   - post in videolan-announce (moderated), vlc et vlc-devel
107     You are advised to add the author list for this version 'git shortlog -s PREVIOUS_VERSION..VERSION'
108     And to add git diff --stat PREVIOUS_VERSION..VERSION if it's relevant.
109     You can play a bit with git to show the piece of information that may be interesting.
110   - add a sticky thread in the "General VLC media player discussion" forum
111