Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "EMF Compare/Build"

(→‎Milestone build)
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
= Build job locations =
 
= Build job locations =
  
−
'''The latest version can always be built with the ''Master'' job.''' The current master contains version 2.1.*.
+
'''The latest version can always be built with the ''master-nightly'' job.'''
  
−
* Master : https://hudson.eclipse.org/hudson/view/Modeling/job/emf-compare-master/
+
* Master : https://hudson.eclipse.org/emfcompare/job/master-nightly/
−
* 1.3.* : https://hudson.eclipse.org/hudson/view/Modeling/job/emf-compare-1.3/
+
* 3.2.* : https://hudson.eclipse.org/emfcompare/job/maintenance-3.2/
−
* 1.2.* : https://hudson.eclipse.org/hudson/view/Modeling/job/emf-compare-1.2.0/
+
* 3.1.* : https://hudson.eclipse.org/emfcompare/job/maintenance-3.1/
−
* 1.1.* : https://hudson.eclipse.org/hudson/view/Modeling/job/emf-compare-1.1/
+
* 2.1.* : https://hudson.eclipse.org/emfcompare/job/maintenance-2.1/
 +
* 1.3.* : https://hudson.eclipse.org/emfcompare/job/archived-1.3/
 +
* 1.2.* : https://hudson.eclipse.org/emfcompare/job/archived-1.2/
 +
* 1.1.* : https://hudson.eclipse.org/emfcompare/job/archived-1.1/
  
−
= Update site locations =
+
= p2 repositories (a.k.a. update sites) locations =
  
−
EMF Compare update sites can all be found from the build.eclipse.org server. They are all located within ''/home/data/httpd/download.eclipse.org/modeling/emf/compare/updates/''.
+
[[EMF Compare]] builds are stored in [[Equinox/p2|p2]] repositories that are produced as part of the build process. This section provides an overview of the different repositories maintained by the EMF Compare project, and their corresponding location and [[Eclipse/Repository retention policy| retention policy]].  
  
−
The "updates" folder contains four sub-folders, each corresponding to one kind of build :
+
EMF Compare update sites are located on the server <code>build.eclipse.org</code> within the folder <code>/home/data/httpd/download.eclipse.org/modeling/emf/compare/updates</code>.
−
* interim => contains the integration ("I") builds.
+
−
* milestones => contains the stable ("S") builds. All milestones and release candidates will be aggregated there.
+
−
* nightly => contains the nightly ("N") builds.
+
−
* releases => contains all of our release ("R") builds.
+
−
 
+
−
Each of these sub-folders are further divided in the versions of the builds they contain. Furthermore, the "release" sub-folder is itself an aggregate update site that contains all of the released versions.
+
−
 
+
−
There is one aggregate update site for each of the "type/version" subfolder that will contain all of the corresponding versions, and one update site for each of the builds. For example, if we promote the "2.1.0M6" milestone, which qualifier was "201303191750", an update site containing only that version will be created in ''milestones/2.1/S201303191750/'', and it will be accessible from p2 at http://download.eclipse.org/modeling/emf/compare/updates/milestones/2.1/S201303191750 . Furthermore, it will be aggregated in the ''milestones/2.1'' update site, accessible from p2 at http://download.eclipse.org/modeling/emf/compare/updates/milestones/2.1 .
+
  
 
= Launching a Build =
 
= Launching a Build =
Line 26: Line 21:
 
Members of the EMF Compare team are the only persons that can launch builds. You will need to be connected to hudson and on the page of the job you want to run (see above).
 
Members of the EMF Compare team are the only persons that can launch builds. You will need to be connected to hudson and on the page of the job you want to run (see above).
  
−
There are four parameters to a build :
+
The build takes a single parameter, the reference target platform, which determines the target eclipse version.
−
* Type
+
−
: N => Nightly. Unstable builds that won't be tested in-depth and are not meant to be largely distributed. One is launched every night.
+
−
: I => Integration. Should be used for builds that are meant to be tested by users, for example if a build has been launched to fix a given bug which resolution must still be verified.
+
−
: M => Maintenance. Not used by EMF Compare.
+
−
: S => Stable. Should be used for every Milestone or Release Candidate (RC) builds.
+
−
: R => Release. Must never be used from hudson. The "R" or "Release" version is in fact a renaming of the latest "Stable" RC build; refer to the promotion instructions below.
+
−
* Alias
+
−
: Must always be filled for "S" type builds. The alias format must follow the rule ''<major>.<minor>.<micro><build alias>''. For example, when building the M7 milestone of version 2.1.0, the alias must be filled to "2.1.0M7" or to "2.1.0RC2" when building the second release candidate.
+
−
* Sign
+
−
: Mandatory for all "S" type builds. This can be left unchecked for N and I builds.
+
−
* Platform
+
−
: Kepler => Default platform at the time of writing. This will mean that the build must be run with Kepler (Eclipse 4.3) dependencies.
+
−
: Juno => If the build must be run against Juno (Eclipse 4.2) dependencies.
+
−
: Indigo => For builds that need Indigo (Eclipse 3.7) dependencies.
+
  
 
= Promotion Instructions =
 
= Promotion Instructions =
  
−
Note that you need access rights on build.eclipse.org so that you can connect via ''ssh build.eclipse.org''. If you need to promote a build but lack a shell access, open a bug such as [https://bugs.eclipse.org/bugs/show_bug.cgi?id=386379 386379] to request an unrestricted shell access explaining "why" you need it.
+
* Launch build on the required hudson job. Let's assume here that you build the latest version through job ''master-nightly''.
−
 
+
−
For release and milestone builds, you will also need write access on
+
−
* the EMF Compare web site ( http://git.eclipse.org/c/www.eclipse.org/emf/compare.git/ ), and
+
−
* the aggregator's repository ( http://git.eclipse.org/c/simrel/org.eclipse.simrel.build.git/ )
+
−
 
+
−
== For all builds ==
+
−
* Launch build on the required hudson job. Let's assume here that you build the latest version through job ''emf-compare-master''.
+
 
* Once the build has passed
 
* Once the build has passed
−
** Connect to build.eclipse.org (''ssh build.eclipse.org'')
+
** Look at the log and search for the string "org.eclipse.emf.compare-feature/target"
−
** Go to the appropriate folder for promotion (here, ''cd /shared/jobs/emf-compare-master/lastSuccessful/archive/packaging/org.eclipse.emf.compare.update/target/promotion/'', replace the job name accordingly)
+
** Just a few lines under that is "The project's OSGi version is x.x.x.yyyyMMddhhmm"
−
** Launch the promoter (''ant -f promoter.xml'')
+
** Copy that version
−
** Keep the build qualifier in mind, it will be indicated in the promoter log (for example, ''201303191750'' was the qualifier of our 2.1.0M6)
+
* Go to the manual publishing job at https://hudson.eclipse.org/emfcompare/job/publish-milestone-manual
−
* Check that the two following update sites both exist and contain a build with the proper qualifier
+
−
** The aggregate site for the build type and version (for example when building EMF Compare 2.1.0M6 : ''http://download.eclipse.org/modeling/emf/compare/updates/milestones/2.1'')
+
−
** The update site that contains solely that build (for example for EMF Compare 2.1.0M6 : ''http://download.eclipse.org/modeling/emf/compare/updates/milestones/2.1/S201303191750'')
+
−
: (All update site locations are explained in the dedicated section above.)
+
  
−
== For the release ==
+
This build takes two parameters, none of which can be empty:
−
The R build will be a copy of the latest RC that was promoted. Promoting the release will be made in two steps : creating the release build, then making it available ; the latter of which should only be done the day of the official release train's release.
+
* '''QUALIFIER''' is the version you've copied just above. Paste it in there.
 +
* '''ALIAS''' is the human readable name for this milestone. By convention, this is "x.x.x<optional milestone name>", for example 3.3.1M7 or 3.3.1RC2.
  
−
=== Creating the release build ===
+
Once the build completes, we need to tag the repository
−
 
+
* Open a terminal at the location of the emf compare clone
−
Let's assume "2.1.0" is the released version here, assume the qualifier of the latest RC, "2.1.0RC4", is 201306110000.
+
* checkout the commit that was built as this milestone if it's not the HEAD
−
All of the following is done on build.eclipse.org.
+
* Tag the commit
−
 
+
** git tag -a '2.1.0M7' -m 'EMF Compare 2.1.0M7 - Luna M7 - 201305060839'
−
'''zips'''
+
*: (git tag -a '<alias>' -m '<message>')
−
 
+
* Make sure you've tagged the right commit for this milestone
−
* Go to the "drops" folder corresponding to your release
+
** git show 2.1.0M7
−
** ''cd /home/data/httpd/download.eclipse.org/modeling/emf/compare/downloads/drops/2.1.0''
+
* Push the tag
−
* copy the folder of the latest RC into a folder with the same qualifier, but with the "R" prefix instead of "S"
+
** git push origin 2.1.0M7
−
** ''cp -r S201306110000 R201306110000''
+
−
* Go into this new folder
+
−
** ''cd R201306110000''
+
−
* Rename all zips and md5 to remove their "RC" alias
+
−
** ''mv emf-compare-update-2.1.0RC4.zip emf-compare-update-2.1.0.zip''
+
−
** ''mv emf-compare-update-2.1.0RC4.zip.md5 emf-compare-update-2.1.0.zip.md5''
+
−
* Change the md5 to remove the alias from the file names
+
−
** ''vi emf-compare-update-2.1.0.zip.md5''
+
−
* Check all md5, it must be OK
+
−
** ''md5sum -c *.md5''
+
−
* Hide the zip from the download page ('''this should be done on your own machine, not on build.eclipse.org''')
+
−
** ''git clone http://git.eclipse.org/c/www.eclipse.org/emf/compare.git/ org.eclipse.emf.compare.website''
+
−
** ''cd org.eclipse.emf.compare.website/downloads''
+
−
** ''vi index.php''
+
−
*** locate the "$hiddenBuilds" variable, and add the zip you wish to hide to that array : ''"2.1.0" => array("R201306110000")''
+
−
* Make sure that the zip does not appear on http://www.eclipse.org/emf/compare/downloads/
+
−
 
+
−
'''update site'''
+
−
* Go to the "releases" folder of the project and create the version's folder if it does not exist yet :
+
−
** ''cd /home/data/httpd/download.eclipse.org/modeling/emf/compare/updates/releases/''
+
−
** ''mkdir 2.1''
+
−
** ''cd 2.1''
+
−
* Create a folder for the release, with the same qualifier as above
+
−
** ''mkdir R201306110000''
+
−
** ''cd R201306110000''
+
−
* Use the mirroring script to replicate the latest RC in this folder
+
−
** ''ant -f /shared/modeling/tools/promotion/mirror-repository.xml -Drepository=/home/data/httpd/download.eclipse.org/modeling/emf/compare/updates/milestones/2.1/S201306110000/''
+
−
: you might get "unable to satisfy dependency" warnings while mirroring, this isn't an issue at this point.
+
−
 
+
−
=== Making the build available ===
+
−
 
+
−
'''This must not be done before the day of the official release.'''
+
−
* Unhide the zip from the download page ('''this should be done on your own machine, not on build.eclipse.org''')
+
−
** ''cd org.eclipse.emf.compare.website/downloads''
+
−
** ''vi index.php''
+
−
*** locate the "$hiddenBuilds" variable, and remove the zip you wish to make available from that array : ''"2.1.0" => array("R201306110000")''
+
−
* Add the release update site to the composite update site of the released version
+
−
** ''ssh build.eclipse.org''
+
−
** ''cd /home/data/httpd/download.eclipse.org/modeling/emf/compare/updates/releases/2.1''
+
−
** ''ant -f /shared/modeling/tools/promotion/manage-composite.xml add -Dchild.repository=R201306110000 -Dcomposite.name="EMF Compare 2.1 Releases"''
+
  
 
= Changing the aggregator (simultaneous release) =
 
= Changing the aggregator (simultaneous release) =
  
−
* Cloner le repository de la release simultanée
+
* Clone the simrel repository
−
** ''git clone ssh://<user>@git.eclipse.org/gitroot/simrel/org.eclipse.simrel.build.git/''
+
** ''git clone ssh://<user>@git.eclipse.org:29418/simrel/org.eclipse.simrel.build.git/''
−
* Install the b3 editor in the eclipse where you'll change the aggregation (for an Eclipse 4.2, it can be installed from http://download.eclipse.org/modeling/emft/b3/updates-4.2)
+
* Install the aggregation editor in the eclipse where you'll change the aggregation (for an Eclipse 4.6 (Neon), it can be installed from http://download.eclipse.org/cbi/updates/aggregator/ide/4.6)
−
* Checkout the simrel project in your eclipse, on the accurate branch (Juno_maintenance for Juno, master for the current release train)
+
* Checkout the simrel project in your eclipse, on the accurate branch (e.g. Juno_maintenance for Juno, master for the current release train)
−
* Open the main simrel file (simrel.b3aggr) with the b3 editor
+
* Open the main simrel file (simrel.aggr) with the aggregation editor
−
* Locate the EMF Compare entry, and change the update site it references so that it points toward the latest milestone (either through the aggregate update site or through the "milestone only" one).
+
* Locate the EMF Compare entry, and change the update site it references so that it points toward the latest milestone (it should be available at "http://download.eclipse.org/modeling/emf/compare/updates/milestones/x.x/SyyyyMMddhhmm", "x.x" and "yyyyMMddhhmm" being the parts of the qualifier you used above to start the publishing job).
−
* Make sure that the file validates (right-click within the b3 editor, then select "Validate Aggregation")
+
* Make sure that the file validates (right-click within the editor, then select "Validate Aggregation")
−
* Commit and push the modification
+
* Commit and push the modification for review
−
** There should only be changes in the ''emf-compare.b3aggrcon'' file.
+
** There should only be changes in the ''emf-compare.aggrcon'' file.
−
 
+
* If the review is succesfully verified by hudson, +2 and push it to the repository.
−
= Checklist =
+
−
 
+
−
== Milestone build ==
+
  
−
* Launch the build from https://hudson.eclipse.org/hudson/view/Modeling/job/emf-compare-master/
+
= Producing the Release build
−
** Make sure the type and alias are correctly filled, and that "sign" is checked for a milestone or RC build.
+
* Go to the manual publishing job at https://hudson.eclipse.org/emfcompare/job/publish-release-manual
−
* Promote the build
+
* This build takes a single parameter, '''QUALIFIER''', which should be of the form x.x.x.yyyyMMddhhmm. Reconstruct it by looking at the update site url for the build you're trying to promote (from https://www.eclipse.org/emf/compare/downloads/)
−
** Note the build qualifier from the build log, it will be reused in multiple places
+
* Start the build and check that the target's "R" update site exists and contains this version of EMF Compare
−
* Check that the two impacted update sites properly contain the build
+
−
** http://download.eclipse.org/modeling/emf/compare/updates/<type>/<version> and
+
−
** http://download.eclipse.org/modeling/emf/compare/updates/<type>/<version>/<qualifier>
+
−
* Check that the build can be installed, via p2, from the aggregate update site
+
−
** http://download.eclipse.org/modeling/emf/compare/updates/<type>/<version>
+
−
* Check that the build appears on the download page, with the appropriate alias if any
+
−
** http://www.eclipse.org/emf/compare/downloads/
+
−
* Make sure that the aggregation references the aggregate milestones update site
+
−
** http://download.eclipse.org/modeling/emf/compare/updates/milestones/<version>
+
−
* Check the aggregation (example for Kepler)
+
−
** https://hudson.eclipse.org/hudson/view/Repository%20Aggregation/job/simrel.kepler.runaggregator/
+
−
** If no build is running, launch one manually... Otherwise wait for the next one.
+
−
** Within the aggregation log, make sure that there are no line mentionning "emf.compare" with a qualifier older than what you just promoted.
+
−
:: (The lines of interest mostly start with "mirroring artifact osgi.bundle".)
+
−
** If an older qualifier appears
+
−
*** Re-open the simrel.b3aggr file, and change it so that it references the "latest milestone only" update site. This will prevent the aggregation from "finding" older builds.
+
−
*** Re-launch the aggregation (you can cancel it manually if the one running was one you launched).
+
−
::: It will most likely fail, but this time the logs will show "who" requires an older version of EMF Compare.
+
−
*** Send a mail to the incriminated project's team or on the cross-projects list to see if they can update their EMF Compare dependency.
+
−
** If the aggregation job fails
+
−
*** The most likely reason is a validation failure of the simrel.b3aggr file.
+
−
*** If you cannot debug the issue, re-open the simrel.b3aggr file and disable the EMF Compare contribution until the problem can be fixed. Mail the cross-project list for help.
+
  
  
  
 
[[Category:EMF Compare]]
 
[[Category:EMF Compare]]

Latest revision as of 10:31, 12 May 2017

Build job locations

The latest version can always be built with the master-nightly job.

p2 repositories (a.k.a. update sites) locations

EMF Compare builds are stored in p2 repositories that are produced as part of the build process. This section provides an overview of the different repositories maintained by the EMF Compare project, and their corresponding location and retention policy.

EMF Compare update sites are located on the server build.eclipse.org within the folder /home/data/httpd/download.eclipse.org/modeling/emf/compare/updates.

Launching a Build

Members of the EMF Compare team are the only persons that can launch builds. You will need to be connected to hudson and on the page of the job you want to run (see above).

The build takes a single parameter, the reference target platform, which determines the target eclipse version.

Promotion Instructions

  • Launch build on the required hudson job. Let's assume here that you build the latest version through job master-nightly.
  • Once the build has passed
    • Look at the log and search for the string "org.eclipse.emf.compare-feature/target"
    • Just a few lines under that is "The project's OSGi version is x.x.x.yyyyMMddhhmm"
    • Copy that version
  • Go to the manual publishing job at https://hudson.eclipse.org/emfcompare/job/publish-milestone-manual

This build takes two parameters, none of which can be empty:

  • QUALIFIER is the version you've copied just above. Paste it in there.
  • ALIAS is the human readable name for this milestone. By convention, this is "x.x.x<optional milestone name>", for example 3.3.1M7 or 3.3.1RC2.

Once the build completes, we need to tag the repository

  • Open a terminal at the location of the emf compare clone
  • checkout the commit that was built as this milestone if it's not the HEAD
  • Tag the commit
    • git tag -a '2.1.0M7' -m 'EMF Compare 2.1.0M7 - Luna M7 - 201305060839'
    (git tag -a '<alias>' -m '<message>')
  • Make sure you've tagged the right commit for this milestone
    • git show 2.1.0M7
  • Push the tag
    • git push origin 2.1.0M7

Changing the aggregator (simultaneous release)

  • Clone the simrel repository
    • git clone ssh://<user>@git.eclipse.org:29418/simrel/org.eclipse.simrel.build.git/
  • Install the aggregation editor in the eclipse where you'll change the aggregation (for an Eclipse 4.6 (Neon), it can be installed from http://download.eclipse.org/cbi/updates/aggregator/ide/4.6)
  • Checkout the simrel project in your eclipse, on the accurate branch (e.g. Juno_maintenance for Juno, master for the current release train)
  • Open the main simrel file (simrel.aggr) with the aggregation editor
  • Locate the EMF Compare entry, and change the update site it references so that it points toward the latest milestone (it should be available at "http://download.eclipse.org/modeling/emf/compare/updates/milestones/x.x/SyyyyMMddhhmm", "x.x" and "yyyyMMddhhmm" being the parts of the qualifier you used above to start the publishing job).
  • Make sure that the file validates (right-click within the editor, then select "Validate Aggregation")
  • Commit and push the modification for review
    • There should only be changes in the emf-compare.aggrcon file.
  • If the review is succesfully verified by hudson, +2 and push it to the repository.

= Producing the Release build

Retrieved from "https://wiki.eclipse.org/index.php?title=EMF_Compare/Build&oldid=416540"

This page was last modified 10:31, 12 May 2017 by Laurent Goubet. Based on work by Mikaël Barbero.

Back to the top