Difference between revisions of "CDT/Obsolete/release engineering"

Revision as of 11:14, 7 October 2017

What do we build today?

CDT is currently built as an update site, archived in a master zip file.

To install CDT:

1. Download the master zip file and put it somewhere on your machine.
2. Fire up Eclipse
3. Help->Software Updates
4. On the Available Features tab, select Manage sites...
5. Add... in the master zip as an Archive...
6. Under CDT Main Features select the one you want. C/C++ Development Tools is the main one. The SDK adds in the schemas and source for building extensions to the CDT. The C/C++ Development Platform is the Tools without the GNU toolchain support.
7. You can install other neat things from the CDT Optional Features category.

This master zip has everything, including:

• CDT Platform Feature - includes editor, search, builders, launch, debug, user documentation
• CDT Runtime Feature - superset of platform feature that adds gnu toolchain integrations for build/debug
• CDT SDK Feature - superset of runtime that adds source and extension point schemas
• GDB Hardware Debugging - provides a launch configuration for launching gdb to do hardware debugging.
• XL C/C++ Compiler Support - provides an error parser and managed build support for IBM's XL C/C++ compilers.
• LR Parser - provides a parser for the ISO/IEC 9899:1999 variant of the C programming language (aka C99) and the C++ programming language, generated from a grammar using the LPG parser generator. The grammar can be reused and extended to create your own parser for variants on the C programming language.
• Unified Parallel C Support - Provides support for the Unified Parallel C programming language. Provides parsing/indexing infrastructure and language definition, allowing the UPC language to be recognized by CDT. Requires the LR parser feature.
• CDT Utilities - provides utilities for C/C++ Development Tools
• CDT Testing Feature - includes all test plugins required for running automated JUnit tests

Building CDT master headlessly with Tycho/Maven

CDT master is built from git using Maven+Tycho (as of CDT 8). Running a headless build is straightforward. (Within the IDE, plugins are automatically built.) Note that Tycho requires Maven 3.0. You can download it directly from Apache.

Building CDT

1. mkdir cdt-releng ; cd cdt-releng
2. git clone git://git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git
3. pushd org.eclipse.cdt
4. mvn clean install
5. popd

Add -Dmaven.skip.test if you don't want maven to run the tests.

The generated p2 repository lives under: releng/org.eclipse.cdt.repo/target/repository/ or compressed at: releng/org.eclipse.cdt.repo/target/org.eclipse.cdt.repo.zip

How do we run the build? How often do we build?

Recent release streams use maven to build. Older release stream have scripts /home/www/tools/cdt/scripts/ that ran on the Eclipse build machine (build.eclipse.org, running Linux/PPC):

These scripts setup the staging area on the build machine for the build.

Builds for CDT 8.0 and more recent are run using Maven.

Scripts for CDT 7.X and earlier check out the latest org.eclipse.cdt.releng plugin in their respective stream. It then runs build.sh and build.xml (in org.eclipse.cdt.releng) where majority of the build logic resides. We rely on the plugins in org.eclipse.releng.basebuilder to run our builds. We use different versions of the basebuilder for various stream builds. More information can be found on http://wiki.eclipse.org/Platform-releng-basebuilder. During the build process, features and plugins are tagged in CVS with the build timestamp. Once the build is completed, it is signed, (JUnit) tested, and made available in the | CDT download area .

Builds against older streams are available upon request.

Miscellaneous release checklist

This is a list of things that need to be done at some point before a release.

• Verify that our target file points to the proper Orbit release, as listed in http://download.eclipse.org/tools/orbit/downloads/
  • This should be done until the version of Orbit targeted to the Simultaneous release is available
• A release record must be created for the release (by project leads).
  • This can be done much in advance to notify users of upcoming releases
  • This can also be done for maintenance release (no API change, no new features) but such release do not need a review
• Old .api_filters files of the previous release can be removed (not necessarily all .api_filters though). To easily and safely find the unused ones:
  • Go to the Problems view and in its menu choose "Group By -> Type"
  • Sort the "Type" column
  • Remove all .api_filters file (optionally using the quick-fix) that correspond to the warnings "Unused API Problem Filter Problem"
• Update all the feature versions using Maven to the upcoming release number. All feature versions should match the release; on the other hand plugins are only bumped to their own next version if they have changes. (The exceptions are the org.eclipse.cdt and org.eclipse.cdt.sdk plug-ins which have the same version as the feature.)
  • Command to use: mvn org.eclipse.tycho:tycho-versions-plugin:set-version -P build-standalone-debugger-rcp -DnewVersion=${NEW_VERSION}-SNAPSHOT
  • Manually update version in debug/org.eclipse.cdt.debug.application/plugin.properties
  • Manually update version in any disabled plug-ins (as of now these are core/org.eclipse.cdt.core.linux.ppc/pom.xml and debug/org.eclipse.cdt.debug.application.tests/pom.xml)
  • Do a grep of the code against the old version to make sure nothing is left, for example in the root of the repo run: git grep 9\\.3\\.3
• Update all p2.inf file to point to the p2 repo. Right now there is only one that has an update site: releng/org.eclipse.cdt-feature/p2.inf
• Add version to Bugzilla
• Add next target milestone to Bugzilla (if known)

How do we release builds?

Steps for M1

CDT does not usually provide a new build for M1 but instead keeps its release build of the previous SimRel. However, CDT should enable itself:

1. State intent to participate in the SimRel by emailing cross-project-dev (e.g., email for Oxygen)
2. Send a patch for org.eclipse.simrel.build which removes the enabled="false" flag from cdt.b3aggrcon (if it was added at the start of the release to make sure project actively enable themselves)
   • The resulting simrel build may fail if CDT depends on projects that have not been enabled yet. There may be circular dependencies between projects (although not between features/plugins), so we may need to enable multiple projects in the same commit like for Oxygen

Steps for the RC1 milestone

The below steps do not apply to maintenance releases which are built from a branch already

1. Optionally copy the new and noteworthy to the user documentation in the git repo, doc/org.eclipse.cdt.doc.user/concepts/cdt_c_whatsnew.htm
   • This makes the documentation grow substantially. Instead, we can opt to simply include the latest link to the N&N on the web
2. Create a branch from master for the release e.g., cdt_9_0.
3. Create a new location for the release on the build machine. E.g.,
   • Log on to build.eclipse.org
   • cd downloads/tools/cdt/builds
   • mkdir 9.0
   • mkdir 9.0/nightly
4. Modify the root pom.xml file to point to a new location for the release. E.g.,
   • <repo-path>tools/cdt/builds/9.0/nightly</repo-path> and <cdt-site>http://hudson.eclipse.org/cdt/job/cdt-9.0/lastSuccessfulBuild/artifact/releng/org.eclipse.cdt.repo/target/repository</cdt-site>
   • Commit this change to the release branch (not master)
5. Create a new HIPP job to build the new branch (can be copied then modified from an existing one)
   • Trigger the new job. The result will be the RC1 to use in the steps below
   • Optionally delete the oldest build branch and job if it is no longer needed
6. Perform general milestones steps below
7. Notify the cdt-dev list about the situation and mention that bug fixes should go in both master and the branch

Steps for milestones

1. A milestone is a good time to update the cdt.target file to point to the most recent dependencies
   1. To find the latest dependencies, one can look at what is made available in the most recent simrel git repo
   2. Update all necessary dependencies in cdt.target
   3. Trigger a new build which will serve as the milestone build
2. See if any steps of the miscellaneous release checklist needs to be done
3. A build job has been created to complete the steps below up to but not including notifying the cdt-dev list. Use with care however, to make sure it works as expected.

====== Begin of steps included in build job ======

1. Log on to build.eclipse.org
   • full shell access is not granted to everyone, usually project-leads have that access
2. cd downloads/tools/cdt/builds
   • this builds directory contains the nightly builds and is not mirrored
   • the nightly builds are put there by our Hudson jobs when using the 'production' maven profile (see releng/org.eclipse.cdt.repo/pom.xml)
3. Copy the latest successful nightly build for the current planned release to its milestone location. E.g., for 8.5 RC3:
   • cp -R 8.5/nightly luna/milestones/sr1-rc3
4. Update the two composite*.xml files to add the new milestone in e.g., luna/milestones
   • This will allow users to use the same update site (http://download.eclipse.org/tools/cdt/builds/luna/milestones) to access the new milestone
   • To allow users to downgrade in case of an issue, we keep the three latest milestones in that file
5. Get the corresponding zip file from the HIPP build. This cannot be accessed from the drive so we use wget. E.g.,
   • cd luna/milestones/sr1-rc3
   • Note that the zip file is not the same as the repository content because it does not contain the pack.gz files. Therefore, we need to get both the repo and the zip from the HIPP and not try to manually generate one from the other.
   • wget https://hudson.eclipse.org/cdt/job/cdt-8.5/lastSuccessfulBuild/artifact/releng/org.eclipse.cdt.repo/target/org.eclipse.cdt.repo.zip
   • mv org.eclipse.cdt.repo.zip cdt-8.5rc3.zip

====== End of steps included in build job ======

1. Notify the cdt-dev list that the build was posted. Mention the different addresses:
   • p2 repo: http://download.eclipse.org/tools/cdt/builds/luna/milestones/
   • zip file: http://download.eclipse.org/tools/cdt/builds/luna/milestones/sr1-rc3/cdt-8.5rc3.zip
   • The commit on which the build was made (can be found by different means, but should be listed at https://hudson.eclipse.org/cdt/job/cdt-8.5/lastSuccessfulBuild/)
2. Update the SimRel repository cdt contribution to use the URL pointing to the specific new milestone
   • If you haven't yet, clone the following https://git.eclipse.org/r/simrel/org.eclipse.simrel.build
   • Update cdt.b3aggrcon to use the new p2 repository for the milestone
   • Push update to SimRel's gerrit for review
   • This is a requirement from SimRel to be able to reproduce builds (see https://wiki.eclipse.org/SimRel/Simultaneous_Release_Requirements#Integrate_Early_and_Often)

Steps during Quiet week

• Add the documentation to the info center (http://help.eclipse.org). This is required every simulaneous release (June release) or if the documentation was updated in a service release. For an example of how to do it, see https://bugs.eclipse.org/bugs/show_bug.cgi?id=436372#c18
• The below steps assume that RC4 is available by the above steps

Should ONLY be done with RC4 as the mirrors will trigger right away
Should be done early during quiet week to give enough time for mirrors to sync (can be done as soon as RC4 is released)

1. Log on to build.eclipse.org
2. cd downloads/tools/cdt/
3. Copy the RC4 build into the release location (releases/[release_name]). E.g., for 9.0:
   • mkdir releases/9.0
   • cp -R builds/neon/milestones/rc4 releases/9.0
   • mv releases/9.0/rc4 releases/9.0/r
4. Rename and move zip file
   • mv releases/9.0/r/cdt-9.0rc4.zip releases/9.0/cdt-9.0.0.zip
5. Make build 'invisible' until release day
   • mv releases/9.0/r/artifacts.jar releases/9.0/r/artifacts.jar.tmp
   • mv releases/9.0/r/content.jar releases/9.0/r/content.jar.tmp
   • mv releases/9.0/r/artifacts.xml.xz releases/9.0/r/artifacts.xml.xz.tmp
   • mv releases/9.0/r/content.xml.xz releases/9.0/r/content.xml.xz.tmp
6. Copy and update the index.php file for RCP stand-alone debugger of the previous release
   • cp releases/8.8/r/rcp/index.php releases/9.0/r/rcp/index.php
   • Update the file by changing the CDT version number (in two locations of the file)

Morning of the release

1. Verify we get a GO on the cross-project-issues-dev mailing list
2. Make the release visible
   • Copy the two composite*.xml file of the previous release to this release and update them
     • cp releases/8.8/composite*.xml releases/9.0
     • Manually update both the files to change the name of the release ("repository name" entry")
   • mv releases/9.0/r/content.jar.tmp releases/9.0/r/content.jar
   • mv releases/9.0/r/artifacts.jar.tmp releases/9.0/r/artifacts.jar
   • mv releases/9.0/r/artifacts.xml.xz.tmp releases/9.0/r/artifacts.xml.xz
   • mv releases/9.0/r/content.xml.xz.tmp releases/9.0/r/content.xml.xz
3. Tag the release (it is best to wait until the day of release in case of re-spins)
4. Update the website (index.php, downloads.php), the website can be modified using this git repo: https://git.eclipse.org/c/www.eclipse.org/cdt.git/
5. Notify the cdt-dev list
6. Update the cdt-baseline.target file to the new release on both master and the maintenance branch
7. Update new and noteworthy on the wiki. Also update the link to it in the main CDT wiki page. And the new in CDT page.
8. Update wiki pages if necessary:
   • Getting started
   • Contributing
   • Policy (especially API tooling section)
   • Using Git with CDT