Release checklist » History » Version 5

Chris Cannam, 2014-07-09 02:28 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 4 Chris Cannam
14 4 Chris Cannam
h4. Categories and RDF
15 4 Chris Cannam
16 4 Chris Cannam
* Make sure you have a sensible category file (@.cat@)
17 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
18 4 Chris Cannam
19 4 Chris Cannam
h4. Packaging
20 4 Chris Cannam
21 4 Chris Cannam
Make sure each package contains at least the following files:
22 4 Chris Cannam
23 1 Chris Cannam
* The plugin library!
24 5 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 4 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 5 Chris Cannam
28 5 Chris Cannam
h4. Publicity
29 5 Chris Cannam
30 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