Release checklist » History » Version 4

Version 3 (Chris Cannam, 2014-07-09 02:19 PM) → Version 4/22 (Chris Cannam, 2014-07-09 02:26 PM)

h1. Release checklist

For the process of building and releasing binaries of a C++ Vamp plugin.

h4. h3. Code hygiene quality

* Run the "Vamp Plugin Tester":/projects/vamp-plugin-tester on the plugin, under "valgrind":http://valgrind.org/

h4. Versioning and tagging

* If this is a new release of a previously-released plugin, remember to increment the plugin's @getPluginVersion()@ value

h4. Categories and RDF

* Make sure you have a sensible category file (@.cat@)
* 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

h4. Packaging

Make sure each package contains at least the following files:

* The plugin library!
* @README@ describing the plugin and how to use it, identifying the authors, with a link to a site about it
* @COPYING@ containing the licence for the plugin
* @CITATION@ containing BibTeX of any paper to cite when using the plugin in academic work