X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=doc%2Frelease-howto.txt;h=acacfd1eadef5fe5dab99dae3c416b04a7abc8a0;hb=f2ab4fa51554164099abbb9caac9083c0bbc90e9;hp=cfb3cde802c8bf22b899ac0afad77697a47d21e5;hpb=e0de322a2341f80aa53a89dbc3d74ce9e0c058b8;p=vlc diff --git a/doc/release-howto.txt b/doc/release-howto.txt index cfb3cde802..acacfd1ead 100644 --- a/doc/release-howto.txt +++ b/doc/release-howto.txt @@ -3,84 +3,100 @@ Release HOWTO ------------- - * Have an ECP guy send a mail to ingesys at cti dot ecp dot fr warning them of - the forecoming traffic (should ideally be done at least a few hours before release) - - * Tests : compilation, regression tests ... - - * Changes on the svn repository - - update the version number everywhere it's needed - · configure.ac - · extras/MacOSX/vlc.pbprj/project.pbxproj - · extras/MacOSX/Resources/English.lproj/InfoPlist.string - - update the ChangeLog and NEWS files, as well as the Trac database - · LANG=C svn log -v -r '{YYYY-12-31}:{YYYY-01-01}' >! ChangeLog - · read all the commits and add important things to the NEWS file - · update the milestones info on https://trac.videolan.org/vlc - - Add a note about the matching contrib package in INSTALL.win32 + * Tests: compilation, regression tests ... + + * Changes on the git repository + - Check that the version number everywhere it's needed + · configure.ac + · NEWS + - Update important things and add them to the NEWS file + - Close the milestone on Trac https://trac.videolan.org/vlc + - Update OpenGPG key embedded in include/vlc_update.h if needed + - Increase the libvlccore and libvlc revisions in src/Makefile.am + _if_and_only_if_ the ABI number has not been increased instead, in + which case the revision goes back to zero. * Commit + * Tag the commit * Tarballs (Use a clean tree !!!) - - Use 'make distcheck' to make sure all files are exported - correctly (currently fails) - - make the VLC tar.gz and tar.bz2 files with `make dist'. - - copy the tar.gz and tar.bz2 file on ftp.videolan.org in - /opt/ftp/pub/videolan/testing/vlc-X.X.X/ - - generate md5 hashes of these files + - Use 'make distcheck' to make sure all files are exported correctly + - copy the tar.xz file on altair.videolan.org + - copy the binaries files on altair.videolan.org, if possible + - generate SHA, MD5 hashes and OpenPGP signature of these files + (use sha*sum --binary, md5sum --binary, gpg --sign --detach --armor) + Use the ~/bin/sumandsign.sh script * Contribs - - Put a copy of the libraries or svn snapshot in vlc-X.X.X/contrib + - Put a copy of the libraries or git snapshot in vlc-X.X.X/contrib - Put the relevant win32 contrib package - Update developers.v.o/vlc and www.v.o/vlc/download-sources.html - * BeOS Packages - Information on building: http://developers.videolan.org/vlc/beos-compile.html - Build in the "buildbeos" chroot on altair. - # add the .zip files to /opt/ftp/pub/videolan/testing/vlc-X.X.X/beos/ - * Win32 Packages - make the packages using the nightly builds configure/options/... - don't forget to test the installer and uninstaller (the first 0.8.4 uninstaller was broken ... kind of suxxs) - add the .zip and .exe files to /opt/ftp/pub/videolan/testing/vlc-X.X.X/win32/ + - configure using the extras/package/win32/configure.sh script + - move to altair and generate md5 plus SHA1 hashes and gpg signature of these files + (c.f. Tarballs) * OS X packages - At the moment, only FK can do them (so they can be compatible with OS X 10.2) - Later: on the G5 + - configure using ./configure --enable-macosx + - compile the source on both a PowerPC and an Intel-based Mac. Don't try to + cross-compile for either platform. Don't forget the framework. + - use extras/package/macosx/ub.sh to create a Universal Binary. + - move to altair and generate md5 plus SHA1 hashes and gpg signature of these files + (c.f. Tarballs) * Commit changes ... it never works the first time * "Tag" the release - svn cp svn://svn.videolan.org/vlc/trunk svn://svn.videolan.org/vlc/tag/X.X.X - or - svn mv svn://svn.videolan.org/vlc/branches/X.X.X svn://svn.videolan.org/vlc/tag/X.X.X + git tag -a -m "VLC Release VERSION" + (Create an annotated tag, you can skip -a if you used -m) + git push origin - * Move /opt/ftp/pub/videolan/testing/vlc-X.X.X to /opt/ftp/pub/videolan/vlc/X.X.X + * Move the signed files from altair to ganesh, on /opt/ftp/pub/videolan/vlc/X.X.X + - At first block access to this directory by http or ftp. Only authorize rsync. + This is to avoid leak as some journalists and forums seem to watch the ftp. + - Update the "last" symlink * Update the website - - edit the /index.php /vlc/*.php pages + - edit the /index.php /vlc/*.php, include/os-specific.php files + - create a /vlc/release/X.X.X page - add a news item to news.msg + - update the front page OS dependant screenshots if the interface changed. + + * "Check for updates" functionality + - edit update.videolan.org/vlc/status + - gpg -t --sign --detach --armor - * Announce on www.gnome.org - - click on "Get more software" - - click on "Edit an existing map entry" - - look for the 'vlc' package - - update the version number and other info and submit - - the change is instantaneaous + * Mirrors (if necessary) + - Forwarn the mirror admins + - Update the list of files for the mirror check + (/var/www/local/mirrors.v.o/files) + - Disable mirrors which haven't synced yet and possibly ganesh if there are + enough other mirrors (see http://mirrors.videolan.org/release.html) - * Announce on www.freshmeat.net (let sam do it) + * Update the wiki + - edit http://wiki.videolan.org/Template:VLC:latest_version + + * Announce on www.freshmeat.net (let jb or sam do it) - you need a freshmeat account - go to http://www.freshmeat.net/projects/vlc/ - - click on the release's branch (ie Stable) - - chose "add release" in the dropdown menu + - chose "Submit a release" in the right menu - fill out all the info and submit - the update can take several hours * Announce on VersionTracker - ask Meuuh - * Announce email + * Announce on twitter and facebook... + Unfortunately, those are more followed than the other means + + * Announce email and forum topic - write something along the lines of previous releases - post in videolan-announce (moderated), vlc et vlc-devel + You are advised to add the author list for this version using + 'git shortlog -s PREVIOUS_VERSION..VERSION' + And to add git diff --stat PREVIOUS_VERSION..VERSION if it's relevant. + You can play a bit with git to show the piece of information that may be + interesting. - add a sticky thread in the "General VLC media player discussion" forum