X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=doc%2Frelease-howto.txt;h=3af9287b77b424308cdb138584d9a7dfa2ff6346;hb=943b5ccc082784273bc21baa216527a605fc8e04;hp=0fbfcb05512493f4cc1f0d2d54304e490c7c0f89;hpb=57bfc6e6796f25b922335ef32f4183b2bafbf9c2;p=vlc diff --git a/doc/release-howto.txt b/doc/release-howto.txt index 0fbfcb0551..3af9287b77 100644 --- a/doc/release-howto.txt +++ b/doc/release-howto.txt @@ -3,29 +3,36 @@ Release HOWTO ------------- - * Tests : compilation, regression tests ... + * Tests: compilation, regression tests ... * Changes on the git 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 git log --since="01-01" --until="12-31" >! ChangeLog - · read all the commits and add important things to the NEWS file - · update the milestones info on https://trac.videolan.org/vlc + · extras/package/macosx/Resources/English.lproj/InfoPlist.strings + · extras/package/macosx/Info.plist + · extras/package/macosx/plugin/English.lproj/InfoPlist.strings + · extras/package/macosx/plugin/Info.plist + · extras/package/macosx/plugin/InstallerInfo.plist + · extras/package/macosx/vlc.xcodeproj/project.pbxproj + - update the ChangeLog and NEWS files, as well as the Trac database: + LANG=C git log --since="01-01" --until="12-31" >! 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 - - Make sure that the gpg key embedded in include/vlc_update.h is the last one + - 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 * Tarballs (Use a clean tree !!!) - Use 'make distcheck' to make sure all files are exported correctly - - copy the tar.gz and tar.bz2 file on ftp.videolan.org in + - copy the tar.bz2 file on ftp.videolan.org in /opt/ftp/pub/videolan/testing/vlc-X.X.X/ - - generate md5 hashes and gpg signature of these files - (use gpg --sign --detach --armor --force-v3-sigs) + - generate SHA1 plus md5 hashes and gpg signature of these files + (use gpg --sign --detach --armor) * Contribs - Put a copy of the libraries or git snapshot in vlc-X.X.X/contrib @@ -37,42 +44,54 @@ Configure with --enable-update-check Build in the "buildbeos" chroot on altair. # add the .zip files to /opt/ftp/pub/videolan/testing/vlc-X.X.X/beos/ - generate md5 hashes and gpg signature of these files - (use gpg --sign --detach --armor --force-v3-sigs) + generate md5 plus SHA1 hashes and gpg signature of these files + (use gpg --sign --detach --armor) * Win32 Packages - make the packages using the nightly builds configure/options/... , don't forget --enable-update-check - don't forget to test the installer and uninstaller (the first 0.8.4 uninstaller was broken ... - kind of suxxs) + make the packages using the nightly builds configure/options/... , don't + forget --enable-update-check + 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/ - generate md5 hashes and gpg signature of these files - (use gpg --sign --detach --armor --force-v3-sigs) + generate md5 plus SHA1 hashes and gpg signature of these files + (use gpg --sign --detach --armor) * OS X packages - configure with --enable-update-check - generate md5 hashes and gpg signature of these files - (use gpg --sign --detach --armor --force-v3-sigs) + Information on compilation: wiki.videolan.org/OSXCompile + configure with --enable-update-check + 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. Test it on + PowerPC and Intel-based Macs. + add the .dmg files to /opt/ftp/pub/videolan/testing/vlc-X.X.X/macosx/ + Nomenclature is vlc-X.X.X-$(PLATFORM).dmg respectively + vlc-plugin-X.X.X-$(PLATFORM).dmg and vlckit-X.X.X-$(PLATFORM).dmg. + Don't put any platform for the UB package. + generate md5 plus SHA1 hashes and gpg signature of these files + (use gpg --sign --detach --armor) * Commit changes ... it never works the first time * "Tag" the release - First make sure you git-commit-ed the ChangeLog all the version release related changes, then: - git tag -a -m "VLC Release VERSION" (Create an annotated tag, you can skip -a if you used -m) git push origin - (You are advised to play with it on the sandrox.git if you feel unconfortable) + (You are advised to play with it on the sandrox.git if you feel + uncomfortable) - * Move /opt/ftp/pub/videolan/testing/vlc-X.X.X to /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 journalist and forum seems to watch the ftp. + * Move /opt/ftp/pub/videolan/testing/vlc-X.X.X to + /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 "latest" symlink * Update the website - edit the /index.php /vlc/*.php pages - add a news item to news.msg + - update the front page OS dependant screenshots if the interface changed. * "Check for updates" functionality - add /opt/ftp/pub/videolan/vlc/X.X.X/vlc-X.X.X-announce @@ -80,25 +99,28 @@ * Mirrors - 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 replicated yet and possibly ganesh if enough - other mirrors + - 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 - * Update wiki + * Update the wiki - edit http://wiki.videolan.org/Template:VLC:latest_version + - put the respective NEWS page to wiki.videolan.org/Changelog/X.X.X + - announce the release on the Main Page * 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 + - the change is instantaneous * Announce on www.freshmeat.net (let 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 + - click on the release's branch (i.e. Stable) + - chose "add release" in the drop-down menu - fill out all the info and submit - the update can take several hours @@ -108,8 +130,10 @@ * Announce email - 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 'git shortlog -s PREVIOUS_VERSION..VERSION' + 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. + 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