d8bbec2d51a02bb1f0258fc96ed01657b24fa65c
[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
19  * Commit
20
21  * Tarballs (Use a clean tree !!!)
22   - Use 'make distcheck' to make sure all files are exported
23     correctly
24   - copy the tar.gz and tar.bz2 file on ftp.videolan.org in
25     /opt/ftp/pub/videolan/testing/vlc-X.X.X/
26   - generate md5 hashes and gpg signature of these files
27
28  * Contribs
29   - Put a copy of the libraries or svn 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     Build in the "buildbeos" chroot on altair.
36     # add the .zip files to /opt/ftp/pub/videolan/testing/vlc-X.X.X/beos/
37
38  * Win32 Packages
39     make the packages using the nightly builds configure/options/...
40     don't forget to test the installer and uninstaller (the first 0.8.4 uninstaller was broken ...
41     kind of suxxs)
42     add the .zip and .exe files to /opt/ftp/pub/videolan/testing/vlc-X.X.X/win32/
43    generate md5 hashes and gpg signature of these files
44
45  * OS X packages
46     At the moment, only FK can do them (so they can be compatible with OS X 10.2)
47     Later: on the G5
48    generate md5 hashes and gpg signature of these files
49
50  * Commit changes ... it never works the first time
51
52  * "Tag" the release
53     svn cp svn://svn.videolan.org/vlc/trunk svn://svn.videolan.org/vlc/tag/X.X.X
54     or
55     svn mv svn://svn.videolan.org/vlc/branches/X.X.X svn://svn.videolan.org/vlc/tag/X.X.X
56
57  * Move /opt/ftp/pub/videolan/testing/vlc-X.X.X to /opt/ftp/pub/videolan/vlc/X.X.X
58   - Update the "latest" symlink
59
60  * Update the website
61   - edit the /index.php /vlc/*.php pages
62   - add a news item to news.msg
63
64  * "Check for updates" functionality
65   - add /opt/ftp/pub/videolan/vlc/X.X.X/vlc-X.X.X-announce
66   - edit update.videolan.org/vlc/status.xml
67
68  * Mirrors
69   - Forwarn the mirror admins
70   - Update the list of files for the mirror check (/var/www/local/mirrors.v.o/files)
71   - Disable mirrors which haven't replicated yet and possibly ganesh if enough
72     other mirrors
73
74  * Update wiki
75   - edit http://wiki.videolan.org/Template:VLC:latest_version
76
77  * Announce on www.gnome.org
78   - click on "Get more software"
79   - click on "Edit an existing map entry"
80   - look for the 'vlc' package
81   - update the version number and other info and submit
82   - the change is instantaneaous
83
84  * Announce on www.freshmeat.net (let sam do it)
85   - you need a freshmeat account
86   - go to http://www.freshmeat.net/projects/vlc/
87   - click on the release's branch (ie Stable)
88   - chose "add release" in the dropdown menu
89   - fill out all the info and submit
90   - the update can take several hours
91
92  * Announce on VersionTracker
93   - ask Meuuh
94
95  * Announce email
96   - write something along the lines of previous releases
97   - post in videolan-announce (moderated), vlc et vlc-devel
98   - add a sticky thread in the "General VLC media player discussion" forum
99