Difference between revisions of "Trace Compass/ReleasePreparation"

Revision as of 13:31, 24 August 2016

Simultaneous release

• To be participate to simultaneous release the participation has to be announced before M4 build.
• Be aware for the release schedule for the simultaneous release. For that follow important dates on the simultaneous release wiki, e.g. https://wiki.eclipse.org/Mars/Simultaneous_Release_Plan

Preparing for a release

• Create a release record well in advance to announce the release. Go to the project page and while logged in, use "Committer Tools"-> "Create new release" on the right. This can be done even before the preceding release is done. It is used to indicate our intention.
• About 2 months before the release, probably around but before RC1, make sure the corresponding release record is properly completed and ready for review.
• Deal with IP. Now that we only accept contribution through Gerrit, there really shouldn't be much to do.
  1. Run the bugzilla checker for iplog: https://www.eclipse.org/projects/tools/ip_contribution_review.php?id=tools.tracecompass
  2. Address recommendations which are probably patches that were posted on bugzilla and then moved to Gerrit. In that case mark the patches as iplog-
  3. Generate the IPLog. Go to the project page and while logged in, use "Committer Tools" -> "Generate IPLog (project)" on the right to generate the IPLog.
  4. Review the IPLog created. There shouldn't be much to change, if anything at all.
  5. Submit the IPLog using the button at the bottom of the IPLog page.
  6. Once the IP team finishes the review they will send an email with the approved iplog attached. Save it under something like 1.0-approvedIPLog.html and attach it to the review material on the review page e.g., https://projects.eclipse.org/projects/tools.tracecompass/releases/1.0.0/review
• Prepare the New&Noteworthy page, e.g. https://wiki.eclipse.org/Trace_Compass/News/NewIn10
  • Make sure the page is listed in https://wiki.eclipse.org/Trace_Compass/NewInTraceCompass
  • If this is a service release, you can add a section on the page of the major version, see for example: https://wiki.eclipse.org/Trace_Compass/News/NewIn12#Bugs_fixed_in_the_1.2.1_release
• Request Tools PMC approval for the release by sending an email to "tools-pmc at eclipse.org" of the form

Title: PMC Approval for Trace Compass 1.0
 
 Dear PMC Members,
 
 We'd like PMC approval for the Trace Compass 1.0 major release that is scheduled to coincide with Eclipse Mars.  The release contains bug fixes, new features and API changes [1].
 
 http://projects.eclipse.org/projects/tools.tracecompass/releases/1.0.0/review
 
 The project's IP Log has been submitted and is awaiting approval.
 
 Regards
 Bernd
 
 [1] https://wiki.eclipse.org/Trace_Compass/News/NewIn10 

• Schedule a release review. From the release review page e.g., review for 1.0.0, there should be a green link at the top that says "Schedule a review". Once pressed the review will be available but to make it public an email must be sent to the EMO (emo at eclipse.org) like this:

Title: Please schedule Trace Compass 1.0.0 Release Review
 
 Hi,

 could we please schedule a release review [1] for the next major release of Trace Compass scheduled to coincide with Mars, on June 24th, 2015? PMC approval has been requested [2]
 
 [1] http://projects.eclipse.org/projects/tools.tracecompass/releases/1.0.0/review
 [2] <Add link to email on Trace Compass mailing list that request PMC approval>

 Regards
 Bernd

• Once the above email is sent, the EMO will create a bugzilla for the review e.g., https://bugs.eclipse.org/bugs/show_bug.cgi?id=468035

Preparing milestone builds

• Create milestones update site for the simultaneous release before first milestone build, e.g. M2
  1. Login to build.eclipse.org
  2. Goto to sub-directory downloads/tracecompass
  3. If needed, create directory <release-name>/milestones, e.g. mkdir neon/milestones
  4. Goto sub-directory <release-name>/milestones
  5. Create milestone directory, e.g. mkdir m2
  6. Copy update site content to milestone directory (e.g. m2)
  7. Copy compositeArtifacts.xml and compositeContent.xml from previous release (e.g. mars)
  8. Update both files for current milestone build (e.g. <child location="m2"/>)
• Update simultaneous release aggregator file (tracecompass.b3aggrcon)
  1. Clone repository git://git.eclipse.org/gitroot/simrel/org.eclipse.simrel.build.git and setup Gerrit
  2. Update tracecompass.b3aggrcon file in master branch to point to the milestones directory (e.g. neon/milestones). Note use the b3aggrecon editor for that and not a text editor.
  3. Push Gerrit for code review
• Email Trace Compass mailing list to inform about the milestone build

 Title: Trace Compass Mars M7 posted
 
  Hi,
  
  I posted the Trace Compass Mars M7 build:
  http://download.eclipse.org/tracecompass/mars/milestones/m7/
  
  It is based on commit: 6d16f5a931f0bd9d21ccc04025610fb5a211ec27
  
  RC1 build will be May 19, 2015.
  
  Regards
  Bernd

Release branching and testing

• Announce release plan on Trace Compass mailing list well advance before actual release branch is created
• Create release branch (e.g. stable-1.0) around 1 to 1 1/2 months before the release. Typically right after M7 or RC1 build. Only bugfixes, documentation and test updates are allowed on the release branch. Bugfixes need to backed with bugzilla bug reports.
• Prepare nightly update site and doc directory
  1. Login to build.eclipse.org
  2. Goto sub-directory downloads/tracecompass
  3. Create directory simultaneous release directory, e.g. mars
  4. Create subdirectory stable
  5. Goto directory /home/data/httpd/archive.eclipse.org/tracecompass/doc/
  6. If needed create simultaneous release directory, e.g. mars
  7. Goto simultaneous release directory
  8. Create stable directory
  9. Create doc directories: org.eclipse.tracecompass.doc.dev, org.eclipse.tracecompass.gdbtrace.doc.user, org.eclipse.tracecompass.tmf.pcap.doc.user, org.eclipse.tracecompass.doc.user, org.eclipse.tracecompass.rcp.doc.user
• Create nightly build to build stable branch (copy nightly build)
  1. Use stable branch, e.g. stable-1.0
  2. Update deployment directories, e.g.

 docDestination=/home/data/httpd/archive.eclipse.org/tracecompass/doc/mars/stable
 siteDestination=/home/data/httpd/download.eclipse.org/tracecompass/mars/stable/repository/
 rcpSiteDestination=/home/data/httpd/download.eclipse.org/tracecompass/mars/stable/rcp-repository/
 rcpDestination=/home/data/httpd/download.eclipse.org/tracecompass/mars/stable/rcp/

• Update update site to stable in tracing.product
• Execute manual test cases for the release (see Test Reports) and fix bugs found. This should be a team effort.

Finalizing release on release day

• Create release update sites
  1. Login to build.eclipse.org
  2. Goto to sub-directory downloads/tracecompass/releases
  3. Create directory with release number, e.g. 1.0.0
  4. Goto release directory, e.g. 1.0.0
  5. Using the RC4 build, copy update site "repository", rcp update site "rcp-repository" and location "rcp" of RCP archives to the release directory
  6. Clear stable directory download/tracecompass/stable.
  7. Copy directory "repository", "rcp-repository" and "rcp" from release directory to the stable directory (download/tracecompass/stable).
  8. Clear stable doc directory /home/data/httpd/archive.eclipse.org/tracecompass/doc/stable.
  9. Copy doc from nightly build of stable directory, e.g. /home/data/httpd/archive.eclipse.org/tracecompass/doc/mars/stable
• Update the Trace Compass download page at [1].
• Update tracecompass-stable-nightly job on Hudson to build stable branch (e.g. stable-1.0) tracecompass-stable-nightly
• In Eclipse, tag commit with release tag, e.g. v1.0.0 and push to the main repository
• Upload test report to the Eclipse wiki and update Test Reports wiki page.
• Send email to Trace Compass developer mailing list to announce release.

 Title: Trace Compass 1.0.0 is released
 
  Hi, 
  
  The Trace Compass team is pleased to announce that the release 1.0.0 for Mars is now available 
  from the project's download page [1]. Details are available on the New & Noteworthy page [2].
  
  The Trace Compass p2 repository is up at http://download.eclipse.org/tracecompass/releases/1.0.0/repository/
  
  The Trace Compass standalone RCP is available from: http://download.eclipse.org/tracecompass/releases/1.0.0/rcp/
   
  The tag v1.0.0 maps to the commit 9d298f5b1fb60450bcb92c752af4ae22bbe19ed9
  
  Congratulations and thanks to everyone!
   
  Regards
  Bernd
  
  [1] https://projects.eclipse.org/projects/tools.tracecompass/downloads
  [2] https://wiki.eclipse.org/Trace_Compass/News/NewIn10

• Update Marketplace entry [2]