There are two types of builds: Nightly and Integration. Nightly ("N") builds run every night and are built with the latest on the HEAD stream in the repository. Integration ("I") builds run once a week and build specific versions of the code as tagged in the repository.
Contributing changes to the build
Contributing to a nightly build is easy, just commit your code to the Orion repository and it will be included in the nightly build.
Contributing to an Integration build involves tagging your changes and modifying the map files. Map files are used to specify where a project is located in the repository and what version of that project to use in the build. The map files are located in the org.eclipse.orion.releng project.
Setting up your workspace
- See Orion/Getting the source for instructions on how to set up your workspace to work with Orion source code.
- Import 'org.eclipse.orion.releng' into your workspace. It is located in the org.eclipse.orion.server.git repository under the releng folder.
Contributing your changes
Once you have made code changes, you can contribute them to the Integration build as follows:
- Commit your changes to the local repository and push them to the master
git commit -a -m "fix lots of bugs" #commits all changes git push #push local commits to the master
- Tag the git repository and push the tag to the master
git tag v20110127-1300 git push --tags
The tag specified for a project in the map file will be used as the version qualifier for that bundle (or feature) in the build. It is important for this tag to follow a standard format and that we use the same time zone so that the bundle version increments properly over time.
The standard format to use is vYYYYMMDD-HHMM (HH is in 24 hour form. By convention we use EST time zone, the time zone for Ottawa.)
Unlike CVS, in git tags apply to the entire repository. It is important to include the time in the tag instead of just the day because if someone else tags another project in the same repository, we don't want the original tag to get moved, which would change which changes make it into the build.
Update the Map File
Open the map file containing the entry for your project. This is usually org.eclipse.orion.releng/maps/orion.map.
- Find the entry for the project containing your changes and update it to match your new tag.
As an example, the entry for org.elipse.orion.client.core looks like this:
- Commit your change to the git repo and push it back to the master
git add releng/org.eclipse.orion.releng/maps/orion.map #in the server repo, add this change to be committed git commit -m "bug ####" #commit the change git push #push the change to the master
For lots of good reasons, a project's tag in the map file should generally only updated if that project contains changes. If a single person is going to tag multiple projects and does not know which of those projects actually contain changes, then some tooling is required.
There is currently no equivalent of the cvs releng tool used by the Eclipse Platform team to manage map files. (See bug 328745). There is a shell script written for e4, see the E4/Git#Submitting_for_a_build page for details.