Release checklist » History » Version 15
For the process of building and releasing binaries of a C++ Vamp plugin.
- Run the Vamp Plugin Tester on the plugin, under
valgrind --leak-check=full(see valgrind), and fix everything it reports.
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
- 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 (
- Generate an RDF template using the
vamp-rdf-template-generatorprogram found in
rdf/generatorin the Vamp plugin SDK, and edit it to contain correct metadata
- Make sure your release build is built in release mode ! i.e. with optimization turned on.
- Top priority build targets:
- 32-bit Windows
- 64-bit OS/X Intel
- 64-bit Linux, if you are not providing source
- 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)
- 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.
- Test each build on an installation of the platform that does not have any developer tools installed.
- Make sure each package contains at least the following files:
- The plugin library!
READMEdescribing the plugin and how to install and use it, identifying the authors, with a link to a site about it
COPYINGcontaining the licence for the plugin
CITATIONcontaining BibTeX of any paper to cite when using the plugin in academic work
- Create the source package using
hg archiveor equivalent to archive directly from your tagged version