Update: supports file v4 signatures

[vlc] / doc / release-howto.txt

diff --git a/doc/release-howto.txt b/doc/release-howto.txt
index 68ecfecd45d387e5651fb79a6d3aadd0fc3392e6..10def46e8a4692b63e249eab1d5c7f8a394ac2ce 100644 (file)
--- a/doc/release-howto.txt
+++ b/doc/release-howto.txt
@@ -5,16 +5,15 @@
 
  * Tests : compilation, regression tests ...
 
- * Changes on the svn repository
+ * 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 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
+     · configure.ac
+     · extras/MacOSX/vlc.pbprj/project.pbxproj
+     · extras/MacOSX/Resources/English.lproj/InfoPlist.string
+     · 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
 
  * Commit
 
@@ -23,36 +22,48 @@
     correctly
   - 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
+  - generate md5 hashes and gpg signature of these files
+    (use gpg --sign --detach --armor)
 
  * 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
+    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)
 
  * Win32 Packages
-    make the packages using the nightly builds configure/options/...
+    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)
 
  * 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 with --enable-update-check
+   generate md5 hashes and gpg signature of these files
+   (use gpg --sign --detach --armor)
 
  * 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" <VERSION>
+    (Create an annotated tag, you can skip -a if you used -m)
+    git push origin <VERSION>
+
+    (You are advised to play with it on the sandrox.git if you feel unconfortable)
 
  * 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.
   - Update the "latest" symlink
 
  * Update the website
@@ -63,6 +74,15 @@
   - add /opt/ftp/pub/videolan/vlc/X.X.X/vlc-X.X.X-announce
   - edit update.videolan.org/vlc/status.xml
 
+ * 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 wiki
+  - edit http://wiki.videolan.org/Template:VLC:latest_version
+
  * Announce on www.gnome.org
   - click on "Get more software"
   - click on "Edit an existing map entry"
@@ -84,5 +104,8 @@
  * 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'
+    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