ce8bea4f8d0105cd0bbba7c495267794e5cf5d2c
[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 svn 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    - update the ChangeLog and NEWS files, as well as the Trac database
14      · LANG=C svn log -v -r '{YYYY-12-31}:{YYYY-01-01}' >! ChangeLog
15      · read all the commits and add important things to the NEWS file
16      · update the milestones info on https://trac.videolan.org/vlc
17    - Add a note about the matching contrib package in INSTALL.win32
18    - Make sure that the gpg key embedded in include/vlc_update.h is the last one
19
20  * Commit
21
22  * Tarballs (Use a clean tree !!!)
23   - Use 'make distcheck' to make sure all files are exported
24     correctly
25   - copy the tar.gz and tar.bz2 file on ftp.videolan.org in
26     /opt/ftp/pub/videolan/testing/vlc-X.X.X/
27   - generate md5 hashes and gpg signature of these files
28
29  * Contribs
30   - Put a copy of the libraries or svn snapshot in vlc-X.X.X/contrib
31   - Put the relevant win32 contrib package
32   - Update developers.v.o/vlc and www.v.o/vlc/download-sources.html
33
34  * BeOS Packages
35     Information on building: http://developers.videolan.org/vlc/beos-compile.html
36     Configure with --enable-update-check
37     Build in the "buildbeos" chroot on altair.
38     # add the .zip files to /opt/ftp/pub/videolan/testing/vlc-X.X.X/beos/
39    generate md5 hashes and gpg signature of these files
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
48  * OS X packages
49    configure with --enable-update-check
50    generate md5 hashes and gpg signature of these files
51
52  * Commit changes ... it never works the first time
53
54  * "Tag" the release
55     svn cp svn://svn.videolan.org/vlc/trunk svn://svn.videolan.org/vlc/tag/X.X.X
56     or
57     svn mv svn://svn.videolan.org/vlc/branches/X.X.X svn://svn.videolan.org/vlc/tag/X.X.X
58
59  * Move /opt/ftp/pub/videolan/testing/vlc-X.X.X to /opt/ftp/pub/videolan/vlc/X.X.X
60   - At first block access to this directory by http or ftp. Only authorize rsync.
61     This is to avoid leak as some journalist and forum seems to watch the ftp.
62   - Update the "latest" symlink
63
64  * Update the website
65   - edit the /index.php /vlc/*.php pages
66   - add a news item to news.msg
67
68  * "Check for updates" functionality
69   - add /opt/ftp/pub/videolan/vlc/X.X.X/vlc-X.X.X-announce
70   - edit update.videolan.org/vlc/status.xml
71
72  * Mirrors
73   - Forwarn the mirror admins
74   - Update the list of files for the mirror check (/var/www/local/mirrors.v.o/files)
75   - Disable mirrors which haven't replicated yet and possibly ganesh if enough
76     other mirrors
77
78  * Update wiki
79   - edit http://wiki.videolan.org/Template:VLC:latest_version
80
81  * Announce on www.gnome.org
82   - click on "Get more software"
83   - click on "Edit an existing map entry"
84   - look for the 'vlc' package
85   - update the version number and other info and submit
86   - the change is instantaneaous
87
88  * Announce on www.freshmeat.net (let sam do it)
89   - you need a freshmeat account
90   - go to http://www.freshmeat.net/projects/vlc/
91   - click on the release's branch (ie Stable)
92   - chose "add release" in the dropdown menu
93   - fill out all the info and submit
94   - the update can take several hours
95
96  * Announce on VersionTracker
97   - ask Meuuh
98
99  * Announce email
100   - write something along the lines of previous releases
101   - post in videolan-announce (moderated), vlc et vlc-devel
102   - add a sticky thread in the "General VLC media player discussion" forum
103