release-howto.txt 3.89 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3
[ Note: this howto is probably useful to core vlc developers only ]

  Release HOWTO
Clément Stenac's avatar
Clément Stenac committed
4 5
  -------------

6
 * Tests: compilation, regression tests ...
Sam Hocevar's avatar
 
Sam Hocevar committed
7

8
 * Changes on the git repository
9
   - Check that the version number everywhere it's needed
Rémi Denis-Courmont's avatar
UTF-8  
Rémi Denis-Courmont committed
10
     · configure.ac
11 12 13
     · NEWS
   - Update important things and add them to the NEWS file
   - Close the milestone on Trac https://trac.videolan.org/vlc
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
14 15
   - Update OpenGPG key embedded in include/vlc_update.h if needed
   - Increase the libvlccore and libvlc revisions in src/Makefile.am
16 17
      _if_and_only_if_ the ABI number has not been increased instead, in
      which case the revision goes back to zero.
Sam Hocevar's avatar
 
Sam Hocevar committed
18

Sam Hocevar's avatar
 
Sam Hocevar committed
19
 * Commit
20
 * Tag the commit
Sam Hocevar's avatar
 
Sam Hocevar committed
21

22
 * Tarballs (Use a clean tree !!!)
23 24 25
  - 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
26 27
  - generate SHA, MD5 hashes and OpenPGP signature of these files
    (use sha*sum --binary, md5sum --binary, gpg --sign --detach --armor)
28
    Use the ~/bin/sumandsign.sh script
Sam Hocevar's avatar
 
Sam Hocevar committed
29

30
 * Contribs
31
  - Put a copy of the libraries or git snapshot in vlc-X.X.X/contrib
32 33 34
  - Put the relevant win32 contrib package
  - Update developers.v.o/vlc and www.v.o/vlc/download-sources.html

35
 * Win32 Packages
36
  - configure using the extras/package/win32/configure.sh script
37
  - move to altair and generate md5 plus SHA1 hashes and gpg signature of these files
38
    (c.f. Tarballs)
Sam Hocevar's avatar
 
Sam Hocevar committed
39

Clément Stenac's avatar
Clément Stenac committed
40
 * OS X packages
41 42
  - configure using ./configure --enable-macosx
  - compile the source on both a PowerPC and an Intel-based Mac. Don't try to
43
    cross-compile for either platform. Don't forget the framework.
44 45 46
  - 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)
Clément Stenac's avatar
Clément Stenac committed
47

48
 * Commit changes ... it never works the first time
Sam Hocevar's avatar
 
Sam Hocevar committed
49

50
 * "Tag" the release
51
    git tag -a -m "VLC Release VERSION" <VERSION>
52
    (Create an annotated tag, you can skip -a if you used -m)
53
    git push origin <VERSION>
54

55 56 57 58
 * 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
59

60
 * Update the website
61 62
  - edit the /index.php /vlc/*.php, include/os-specific.php files
  - create a /vlc/release/X.X.X page
63
  - add a news item to news.msg
64
  - update the front page OS dependant screenshots if the interface changed.
Sam Hocevar's avatar
 
Sam Hocevar committed
65

66
 * "Check for updates" functionality
67
  - edit update.videolan.org/vlc/status
68
  - gpg -t --sign --detach --armor
69

70
 * Mirrors (if necessary)
71
  - Forwarn the mirror admins
72 73 74
  - 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
Antoine Cellerier's avatar
Antoine Cellerier committed
75
    enough other mirrors (see http://mirrors.videolan.org/release.html)
76

77
 * Update the wiki
78 79
  - edit http://wiki.videolan.org/Template:VLC:latest_version

80
 * Announce on www.freshmeat.net (let jb or sam do it)
81 82
  - you need a freshmeat account
  - go to http://www.freshmeat.net/projects/vlc/
83
  - chose "Submit a release" in the right menu
84 85
  - fill out all the info and submit
  - the update can take several hours
Christophe Massiot's avatar
Christophe Massiot committed
86

87 88
 * Announce on VersionTracker
  - ask Meuuh
Sam Hocevar's avatar
 
Sam Hocevar committed
89

90 91 92
 * Announce on twitter and facebook...
  Unfortunately, those are more followed than the other means

Antoine Cellerier's avatar
Antoine Cellerier committed
93
 * Announce email and forum topic
94 95
  - write something along the lines of previous releases
  - post in videolan-announce (moderated), vlc et vlc-devel
96 97
    You are advised to add the author list for this version using
    'git shortlog -s PREVIOUS_VERSION..VERSION'
98
    And to add git diff --stat PREVIOUS_VERSION..VERSION if it's relevant.
99 100
    You can play a bit with git to show the piece of information that may be
    interesting.
101
  - add a sticky thread in the "General VLC media player discussion" forum
Clément Stenac's avatar
Clément Stenac committed
102