Release checklist » History » Version 13

Chris Cannam, 2014-07-09 05:16 PM

1 1 Chris Cannam
h1. Release checklist
2 1 Chris Cannam
3 1 Chris Cannam
For the process of building and releasing binaries of a C++ Vamp plugin.
4 1 Chris Cannam
5 4 Chris Cannam
h4. Code hygiene
6 3 Chris Cannam
7 1 Chris Cannam
* Run the "Vamp Plugin Tester":/projects/vamp-plugin-tester on the plugin, under "valgrind":http://valgrind.org/
8 4 Chris Cannam
9 4 Chris Cannam
h4. Versioning and tagging
10 4 Chris Cannam
11 5 Chris Cannam
* Check that copyright dates are correct and up-to-date
12 4 Chris Cannam
* If this is a new release of a previously-released plugin, remember to increment the plugin's @getPluginVersion()@ value
13 6 Chris Cannam
* Tag the repository when you have confirmed that the plugin builds successfully on all target platforms
14 4 Chris Cannam
15 4 Chris Cannam
h4. Categories and RDF
16 4 Chris Cannam
17 4 Chris Cannam
* Make sure you have a sensible category file (@.cat@)
18 4 Chris Cannam
* Generate an RDF template using the @vamp-rdf-template-generator@ program found in @rdf/generator@ in the Vamp plugin SDK, and edit it to contain correct metadata
19 4 Chris Cannam
20 12 Chris Cannam
h4. Platform builds
21 7 Chris Cannam
22 10 Chris Cannam
* Make sure your _release build_ is built in _release mode_ ! i.e. with optimization turned on.
23 8 Chris Cannam
24 7 Chris Cannam
* Top priority build targets:
25 13 Chris Cannam
** 32-bit Windows
26 13 Chris Cannam
** 64-bit OS/X Intel
27 11 Chris Cannam
** 64-bit Linux, _if_ you are not providing source
28 7 Chris Cannam
29 7 Chris Cannam
* Second-tier build targets:
30 7 Chris Cannam
** 32-bit Linux
31 7 Chris Cannam
** 64-bit Linux
32 7 Chris Cannam
** 32-bit OS/X Intel (or universal binary)
33 7 Chris Cannam
34 1 Chris Cannam
* Third-tier build targets:
35 1 Chris Cannam
** 64-bit Windows (may become higher-priority in future though)
36 13 Chris Cannam
37 13 Chris Cannam
* Test each platform build on the oldest and newest platform releases you intend to support -- e.g. Windows XP and Windows 8; OS/X 10.6 and 10.10.
38 13 Chris Cannam
* Test each build on an installation of the platform that does not have any developer tools installed.
39 7 Chris Cannam
40 1 Chris Cannam
h4. Packaging
41 6 Chris Cannam
42 6 Chris Cannam
* Make sure each package contains at least the following files:
43 6 Chris Cannam
** The plugin library!
44 6 Chris Cannam
** @README@ describing the plugin and how to install and use it, identifying the authors, with a link to a site about it
45 6 Chris Cannam
** @COPYING@ containing the licence for the plugin
46 6 Chris Cannam
** @CITATION@ containing BibTeX of any paper to cite when using the plugin in academic work
47 1 Chris Cannam
* Create the source package using @hg archive@ or equivalent to archive directly from your tagged version
48 5 Chris Cannam
49 5 Chris Cannam
h4. Publicity
50 5 Chris Cannam
51 5 Chris Cannam
* Send details of your plugin's download location and the RDF metadata file to cannam@all-day-breakfast.com for inclusion in "the download page":http://vamp-plugins.org/download.html