doc/release-howto.txt

   1 Release HOWTO
   2 -------------
   3
   4 [ Note: this howto is probably useful to core vlc developers only ]
   5
   6  * Tests: compilation, regression tests ...
   7
   8  * Changes on the git repository
   9    - Check that the version number everywhere it's needed
  10      · configure.ac
  11      · NEWS
  12    - Update important things and add them to the NEWS file
  13    - Close the milestone on Trac https://trac.videolan.org/vlc
  14    - Update OpenGPG key embedded in include/vlc_update.h if needed
  15    - Increase the libvlccore and libvlc revisions in src/Makefile.am
  16       _if_and_only_if_ the ABI number has not been increased instead, in
  17       which case the revision goes back to zero.
  18
  19  * Commit
  20  * "Tag" the release
  21     git tag -a -m "VLC Release VERSION" <VERSION>
  22     (Create an annotated tag, you can skip -a if you used -m)
  23     git push origin <VERSION>
  24
  25  * Tarballs (Use a clean tree !!!)
  26   - Use 'make distcheck' to make sure all files are exported correctly
  27   - copy the tar.xz file on ganesh.videolan.org
  28   - generate SHA, MD5 hashes and OpenPGP signature of these files :
  29         for file in vlc*; do
  30             for sum in md5 sha1 sha256; do
  31                 ${sum}sum --binary $file > $file.$sum
  32             done
  33             gpg -sb -u VideoLAN\ Release --armor --force-v3-sigs $file
  34         done
  35
  36  * Contribs
  37   - Put a copy of the libraries or git snapshot in ftp://ftp.videolan.org/pub/contrib/
  38   - Put the relevant win32 and Mac OS contrib package
  39   - Update s.v.o/vlc and www.v.o/vlc/download-sources.html
  40
  41  * Win32 Packages
  42   - configure using the extras/package/win32/configure.sh script
  43   - copy the packages files on ganesh.videolan.org
  44   - copy the vlc-2.0.4 and symbols-2.0.4 to balthazar for stacktraces
  45
  46  * Mac OS X packages
  47   - configure using the extras/package/macosx/configure.sh script
  48   - use extras/package/macosx/codesign.sh with options and key to sign it.
  49   - copy the package to ganesh.videolan.org
  50
  51  * Sign all the files and move the signed files on /opt/ftp/pub/videolan/vlc/X.X.X
  52   - At first block access to this directory by http or ftp. Only authorize rsync.
  53     This is to avoid leak as some journalists and forums seem to watch the ftp.
  54   - Update the "last" symlink
  55
  56  * Update the website
  57   - edit the /index.php /vlc/*.php, include/os-specific.php files
  58   - create a /vlc/release/X.X.X page
  59   - add a news item to news.msg
  60   - update the front page OS dependent screenshots if the interface changed.
  61   - update the md5
  62
  63  * "Check for updates" functionality
  64   - edit update.videolan.org/vlc/status
  65   - gpg -u VideoLAN\ Release -t --sign --detach --armor
  66   - for i in *asc;do gpg --verify $i || echo $i;done
  67
  68  * Mirrors
  69   - Forwarn the mirror admins (optional for any minor release)
  70   - Go to https://get.videolan.org/<path-to-the-file>?mirrorlist
  71   - Ensures there is enough mirrors able to serve the file in each region
  72     or just wait few more hours before doing the release.
  73     Suggested number of mirrors:
  74         - > 70% for a minor release
  75         - > 80% for a major release
  76         - > 80% for any auto-update
  77   - Keep an eye on https://get.videolan.org/?mirrorstats during the release
  78
  79  * Update the wiki
  80   - edit http://wiki.videolan.org/Template:VLC:latest_version
  81
  82  * Announce on www.freecode.com (let jb or sam do it, if you lack the account)
  83   - go to https://freecode.com/projects/vlc/
  84   - chose "Submit a release" in the right menu, in "Administration"
  85   - Do the steps and wait (the update can take several hours)
  86
  87  * Announce on Twitter, Facebook and G+
  88   Unfortunately, those are more followed than the all other mediums combined
  89
  90  * Announce email and forum topic
  91   - Write something along the lines of previous releases
  92   - Post in videolan-announce (moderated), vlc et vlc-devel
  93     You are advised to add the author list for this version using
  94     'git shortlog -s PREVIOUS_VERSION..VERSION'
  95     And to add git diff --stat PREVIOUS_VERSION..VERSION if it's relevant.
  96     You can play a bit with git to show the piece of information that may be
  97     interesting.
  98   - Add a sticky thread in the "General VLC media player discussion" forum
  99