Release checklist¶

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

Code hygiene¶

• Run the Vamp Plugin Tester on the plugin, under valgrind

Versioning and tagging¶

• Check that copyright dates are correct and up-to-date
• If this is a new release of a previously-released plugin, remember to increment the plugin's getPluginVersion() value
• Tag the repository when you have confirmed that the plugin builds successfully on all target platforms

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

Building¶

• Top priority build targets:
  • 32-bit Windows
  • 64-bit OS/X Intel

• Second-tier build targets:
  • 32-bit Linux
  • 64-bit Linux
  • 32-bit OS/X Intel (or universal binary)

• Third-tier build targets:
  • 64-bit Windows (may become higher-priority in future though)

Packaging¶

• Make sure each package contains at least the following files:
  • The plugin library!
  • README describing the plugin and how to install and 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
• Create the source package using hg archive or equivalent to archive directly from your tagged version

Publicity¶

• 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