Skip to main content
Jump to: navigation, search

RMF/Contributor Guide/Build Process

< RMF
Revision as of 10:46, 6 August 2012 by Michael.jastram.de (Talk | contribs) (Publishing Artifacts)

We're still in the incubator phase - therefore, the release process is still being developed. Here are our guidelines so far:

The Most Important Stuff

  • Our release manager is Lukas Ladenberger. Please coordinate with Lukas.
  • We use the Git Flow Process as our release process
  • Important: Never commit to master! (unless you are the release manager). Development takes place on the develop branch)
  • The only branches on the server are master and develop. All other branches that are mentioned in git-flow are local branches

Glossary

(17-Jan-2012) There has been a lot of discussion on rmf-dev. Some of the confusion stems from sloppy terminology. Therefore, here a little glossary:

Release 
A Release is a super-official artifact that is typically published after reaching a number of milestones and building a few release candidates. A Release of RMF is somewhere in the far future and not yet planned.
Milestone 
A milstone is a well-defined point towards a release. No milestones are yet planned for RMF.
Release Candidate 
After the last milestone before a release, one ore more release candidates are built. No major features may go into a RC, only bug fixes.
Nightly Built 
A nightly built is typically generated by an continuous integration system, based on the latest code in the repository (develop branch in Git) and may be instable. It is published, so that daring users can try it out. As we currently don't have a CI system, we don't have nightly builts.
Snapshot 
Similar to a nightly built, but built on demand from the latest sources and published (master branch in Git).
Integration 
We use the term "Integration" to mark the end of a development iteration. We use a schedule-driven (rather than feature-driven) development process. Integrations are created in the Milestone-Field in Bugzilla. At the beginning of a development iteration, all bugs are reviewed by the team and assigned to an integration.

Development Process

For now, we use a schedule-driven, iterative development process. An iteration is 8 weeks long and consists of the following steps:

  • Review and revise the Roadmap
  • Review open issues (bugs and feature requests) and decide which issues should be resolved in the upcoming iteration. Those issues will be assigned to the corresponding integration (e.g. i12.03 for the March 2012 integration).
  • Developers get busy implementing.
  • At the end of the iteration, a snapshot is published, both in the form of a product built and update site (Bonus: once we have a CI system, this is probably just a link to the corresponding nightly built).
  • Rinse, repeat.

Version Numbers

We have version numbers for:

  • Plugins
  • Features
  • Product
  • Project

We have the following rules:

  • While in the incubation phase, all major version numbers remain 0.
  • While in the incubation phase, we will always generate qualifiers.
  • Plugins: The minor and service numbers are incremented according to the Eclipse version rules.
  • Features: The minor and service numbers are incremented according to the Eclipse version rules.

We have not decided yet what to do about the version number of product and project. One suggestion is:

  • Create an "overarching" feature that aggregates all other features (e.g. an SDK Feature). Once such a feature is created, its version number is incremented according to the Eclipse version rules. Use the same version number for the product.

(mj) I don't quite like this, as it feels arbitrary and rather meaningless. OTOH, it would work and is kind of predictable.

Once we leave incubator phase, we will join the Eclipse release train and therefore conform the the relase train requirements. The major version number will graduate beyond zero, once we leave incubation. For now, the plugin and feature name must follow a (Incubation) mark.

GIT

We will tag snapshots as snapshot-0.1.0-yyyymmddhhmm. We will merge the snapshot code to the master branch.

Only the release manager creates tags.

Publishing Artifacts

Only snapshots artifacts will be published, both as stand-alone builds and update site builds. Nightly builds are available via Jenkins and won't be published!

Integration-Release Checklist: Before publishing a snapshot, update the snapshot release checklist (it is located in the dump folder in git). (HTML version)

We still have to figure out how the version number is constructed, the git tag is appended.  Examples:
  • eclipse-rmf-pror-0.1.0-snapshot-yyyymmddhhmm-incubation-linux.gtk.x86.zip
  • eclipse-rmf-pror-0.1.0-nightly-yyyymmddhhmm-incubation-linux.gtk.x86.zip

yyyymmddhhmm <=> qualifier

Download Folder Structure

Currently, we have the following download folder structure:

  • rmf (root folder)
    • updates (Contains the different updates sites)
      • snapshot (Contains the update sites for the snapshot builds)
        • <version number> (e.g. 0.1.0)
    • downloads (Contains all other artifacts like RCP builds)
        • drops
          • <version number> (e.g. 0.1.0)
            • S<buildstamp> (Snapshot build artifacts)

Since, the RMF download page is automatically build based on this structure, it is important to keep it!

More information: [1].

Release Reviews

Note: This is just for reference, as we won't have official releases any time soon.

All official Releases must have a successful Release Review before being made available for download. The purposes of a Release Review are: to summarize the accomplishments of the release, to verify that the IP Policy has been followed and all approvals have been received, to highlight any remaining quality and/or architectural issues, and to verify that the project is continuing to operate according to the Principles and Purposes of Eclipse [2]. More information about a Release Review can be found at: Development_Resources/HOWTO/Release_Reviews.

Release Engineering

Note: This is an initial PROPOSAL for the RMF build system. It is still under discussion.

Requirements

  • The build system shall run on the local workstation as well as on the Eclipse build server [3]
  • The build system shall create the following artifacts:
    • update site
    • standalone executables for windows, linux, mac
  • The build system shall support automated
    • test execution
    • static code analysis
    • javadoc generation
  • The build system shall be based on a technology that is recommended by the Eclipse foundation. This will reduce maintenance costs and it is more likely to get support and find documentation.

Build Infrastructure

In order to be able to maintain Eclipse Software for a long period of time, the Eclipse Foundation has started the Long Term Support Program LTS. Although it is acceptable to have different build systems within the Eclipse Community Build Technologies it is recommended to use the Eclipse Common Build Infrastructure CBI. From a technology point of view, the CBI is a combination of Hudson, Maven, Tycho, and build signing.

For the sake of evaluation an initial build system that is based on Tycho is now available in the development branch for the RMF repository. In order to make use of the Tycho build scripts in your local workspace please install the Maven support for Eclipse m2eclipse. In the workspace you will find the following projects that are related to building the projects

  • org.eclipse.rmf.releng contains the parent pom file which is the starting point for the build. When starting the pom file, you will need to select a target platform. This is done by selecting the profile INDIGO_3_7_1.target
  • org.eclipse.rmf.releng.target contains the target definition
  • org.eclipse.rmf.releng.repository contains the configuration for generating a p2 repository (update-site) (the update site is created into /target/repository)
  • org.eclipse.rmf.releng.product contains the configuration for generating the RMF standalone products (the products are created into /target/products)

All other features, plugins and tests are extended by a pom file. Project specific configuration should be done here. For adding new test cases to the build system, please create a test suite class that follows the naming pattern 'All*Tests.java'

Back to the top