HOWTO

A release build must be reproducible and allow to reliably create service releases based on it. Plug-in Builder supports a clean release process which is described with this HOWTO.

  1. Make sure that HEAD builds properly
  2. Tag the sources
  3. Create a Release Configuration with the Plug-in Builder Editor. Set the following properties
    • The build type will get into the name of the created zip file, it is one of S, I or N indicating stable, integration or nightly builds
    • The version must match the version in the feature.xml except that version is set to 0.0.0
    • The fetch tag marks the tag to check out from the repository. For CVS that is the label, for Subversion it is the (global) revision
    • The version qualifier is the optional 4th part of the version number. It can be freely chosen and often contains the date
    • The build type presentation marks the type of build like build type, but it can be more descriptive and will be appended to the version qualifier
  4. Build using the Release Configuration
  5. Check in the Plug-in Builder project and tag it with the same tag as the sources

For succeeding builds the same Plug-in Builder project can be used.

Example: Plug-in Builder Release 0.1.0

The following steps describe the process of releasing Plug-in Builder 0.1.0. Of course Plug-in builder uses a Plug-in Builder project to build itself , see org.pluginbuilder.build.


Preparing the repository

The first step of the release process is to tag the sources. Plug-in Builder uses subversion and the tag chosen was R20070203-0_1_0. The revision number of that tag became 19.

Creating Release configuration

For every build a release configuration is needed. Per default there is the HEAD configuration which defines nightly or continuous builds. Use the Add button to create a configuration for 0.1.0. Enter a name and the properties:

The buildType is set to S indicating a stable build, version is 0.1.0 and the fetch tag is  19 (the subversion revision). The qualifier marks the date and will be appended with PRD. This results in the full version 0.1.0.20060203PRD.

Build

The build can be executed locally but in order to have a clearly defined environment every release should be built on the server.

The server page of the Plug-in Builder Editor supports release builds, too. First upload the configuration and then select the release you want to build and trigger the build. Meanwhile you can open the browser with the build results directory and wait for the server build to be finished.

Tag Plug-in builder project

The last step is to tag the Plug-in Builder build project itself so that builds can be repeated in the future. Therefore org.pluginbuilder.build was tagged with R20060203-0_1_0, too.