Release checklist » History » Version 20

Chris Cannam, 2014-07-09 05:31 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 20 Chris Cannam
||Tick|
6 16 Chris Cannam
|*Code hygiene*||
7 16 Chris Cannam
|Run the "Vamp Plugin Tester":/projects/vamp-plugin-tester on the plugin, under @valgrind --leak-check=full@ (see "valgrind":http://valgrind.org/), and fix everything it reports||
8 16 Chris Cannam
|*Versioning and tagging*||
9 16 Chris Cannam
|Check that copyright dates are correct and up-to-date||
10 17 Chris Cannam
|If this is a new release of a previously-released plugin, increment the plugin's @getPluginVersion()@ value||
11 17 Chris Cannam
|Tag the repository (when you have confirmed that the plugin builds successfully on all target platforms)||
12 17 Chris Cannam
|Create the source package using @hg archive@ or equivalent to archive directly from your tagged version||
13 17 Chris Cannam
|*Categories and RDF*||
14 17 Chris Cannam
|Make sure you have a sensible category file (@.cat@)||
15 17 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||
16 1 Chris Cannam
17 18 Chris Cannam
||Win32|OS/X|Linux32|Linux64|
18 19 Chris Cannam
|*Platform build checks*|||||
19 17 Chris Cannam
|Make sure _release build_ is built in _release mode_ ! i.e. with optimization turned on|||||
20 17 Chris Cannam
|Test on the oldest and newest releases you intend to support -- e.g. Windows XP and Windows 8; OS/X 10.6 and 10.10|||||
21 17 Chris Cannam
|Test on an installation of the platform that does not have any developer tools installed|||||
22 17 Chris Cannam
|*Make sure package contains...*|||||
23 17 Chris Cannam
|The plugin library!|||||
24 17 Chris Cannam
|@README@ describing the plugin and how to install and use it, identifying the authors, with a link to a site about it|||||
25 17 Chris Cannam
|@COPYING@ containing the licence for the plugin|||||
26 1 Chris Cannam
|@CITATION@ containing BibTeX of any paper to cite when using the plugin in academic work|||||
27 1 Chris Cannam
28 20 Chris Cannam
h4. Publicity
29 20 Chris Cannam
30 20 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
31 20 Chris Cannam
32 20 Chris Cannam
h4. Platform targets
33 20 Chris Cannam
34 17 Chris Cannam
Top priority build targets:
35 17 Chris Cannam
* 32-bit Windows
36 17 Chris Cannam
* 64-bit OS/X Intel
37 17 Chris Cannam
* 64-bit Linux, _if_ you are not providing source
38 6 Chris Cannam
39 1 Chris Cannam
Second-tier build targets:
40 17 Chris Cannam
* 32-bit Linux
41 5 Chris Cannam
* 64-bit Linux
42 5 Chris Cannam
* 32-bit OS/X Intel (or universal binary)
43 1 Chris Cannam
44 1 Chris Cannam
Third-tier build targets:
45 1 Chris Cannam
* 64-bit Windows (may become higher-priority in future though)