Skip to content

RELEASE.md

Latest commit

 

History

History
135 lines (118 loc) · 12 KB

RELEASE.md

File metadata and controls

135 lines (118 loc) · 12 KB

Releng-Tasks 2.1

Eclipse Simultaneous Release Schedule

Milestone and RC Releases

Friday before release week:

  • Create or update prerequisite issues for tracking ECF, EMF and Orbit
  • Send reminder email for upcoming RC week
    • Run the Send Announcement job
      • type: REMINDER_RC
      • rcNumber: number of current RC, 1 or 2

Milestone/RC Week

  • M 1/2/3 Release
    • All milestone releases are 'lightweight', meaning there is no announcement or signoff. No additional builds need to be run, just the daily I-build at 6PM EST. Thursdays build is promoted to SimRel on Friday (unless there are problems with Thursdays build, in which case promote Wednesdays or a later build).
  • Wednesday:
    • Verify that EMF, ECF and Orbit contributions have been included (if applicable).
    • Ensure the build is cleared of comparator errors in doc bundles.
      • If buildlogs/comparatorlogs/buildtimeComparatorDocBundle.log.txt of the latest build is not empty, enforce a qualifier update on the affected doc-bundles
    • Final release candidate build runs at 6PM EST.
    • Because of time zones, PST/EST might want to do Thursday's tasks EOD Wednesday after the release candidate has built.
  • Thursday:
    • Send request to sign-off the current release candidate build
      • Run the Send Announcement job
        • type: SIGNOFF_RC
        • rcNumber: number of current RC, e.g. 1, 2, 2a, ...
        • buildId: ID of the current release candidate I-build, e.g. I20260527-1800
  • Friday:
    • Promote the release candidate (if go).
      • Run the Promote Build job
        • DROP_ID: ID of the build to promote, e.g.: I20250817-1800
        • CHECKPOINT: M1 etc. (blank for final releases)
        • SIGNOFF_ISSUE: Only relevant for RCs, the issue on which sign-off by component leads was requested (numeric part only)
      • For Milestone/RC promotions, this automatically runs the Publish Promoted Build job to make the promoted build immediatly visible on the download page.
        • For release promotions that run has to be started manually at the time of the release
      • It also triggers the Generate Acknowledgements workflow.
      • Contribute to SimRel
        • If you have not already set up SimRel you can do so using Auto Launch here
        • Clone simrel.build (Should have been done by the installer during set up, but make sure you have latest).
          1. Open simrel.aggr in Eclipse
          2. Change to the properties view
          3. Select Contribution:Eclipse > Mapped Repository
          4. Update the Location property to the "Specific repository for building against" in the mailtemplate.txt from promotion.
          5. Commit Simrel updates to GitHub
            • Message should use year-month format, i.e "Simrel updates for Eclipse and Equinox for 2022-06 M1"
    • After RC1
      • Comment on EMF, ECF and Orbit issues to ask for final release builds.

GA Releases

Tasks to be completed after RC2

Release Preparation

Tasks that need to be completed before Friday

The job sending the request to sign-off of RC2, also creates the issue to track the final release steps in this repository.

RC2 Respin

Sometimes there is a critical issue that requires a fix, if it's decided that one is needed then an RC2a (followed by RC2b, RC2c, etc. if necessary) is built from the maintenance branch and promoted using the RC2 process.

  1. Backport the fix to the corresponding maintenance branch
  2. Start a new I-build for that release. The still existing I-build jobs are now running on the maintenance branch and will include the backported fix.
  3. Promote the newly built I-build as RC2a or RC2b, ... and use it for the final release promotion
  • In case the a fix is necessary after the final release promotion happened (but of course before its publication), additionally run the final release promotion with the new RC2x. Also make sure to discard the previously promoted artifacts, by deleting the previously promoted release Eclipse and Equinox download sites and the release update site, in both, the download and archive area. Additionally DROP the artifacts previously staged for Maven Central and replace the final contribution to SimRel.

Release

The actual steps to release

Wednesday, one week before release

  • Promote to GA

    • At the very end of the SimRel RC2 contribution period (usually at Wednesday end of business day), Run the Promote Build job to promote RC2 (or RC2a, ...) to be the final release.
      • DROP_ID: Final release candidate's ID, e.g.: S-4.36RC2-202505281830
      • CHECKPOINT: blank for final releases
    • It creates the download and update sites of the final release at their final location, but does not publish them and keeps them hidden from the public.
    • It also creates pull requests to update the build configuration on the master and corresponding maintenance branch to the promoted release.
      • Submit them IMMEDIATLY BEFORE the release is finally published.
    • It will again update the Acknowledgements and creates a PR if there are any last changes. Review and submit it at https://github.com/eclipse-platform/www.eclipse.org-eclipse/pulls
    • You can subscribe to cross-project-issues to get the notifications on Simrel releases.

  • Contribute to SimRel

    • The final release repo has to be contributed to SimRel before the currently active I-build repo is deleted (is done automatically after the release is published)

Tuesday/Monday

  • Complete Publication to Maven Central

    • The final release to Maven-Central should happen latest by Tuesday before the release since there is up to a 24 hour delay for the Maven mirrors.
    • The artifacts have been deployed into a Maven-Central staging repository by the Promote Build job when the RC was promoted to GA release.
    • Login to https://central.sonatype.com/ and Publish the three staging repositories for Platform, JDT and PDE by closing them.
      • Make sure the name of the deployment you are about to release matches the tag and timestamp of the final release repository. E.g for a P2 repo with id R-4.36-202505281830 the deployments should be named PLATFORM_R-4.36-202505281830, PDE_R-4.36-202505281830 or JDT_R-4.36-202505281830 respectivly.
      • If you do not have an account on central.sonatype.com for performing the rest of the release request one by creating an EF Help Desk issue to get permissions for platform, JDT and PDE projects and tag an existing release engineer to give approval.

Wednesday

The release is scheduled for 10:00 UTC.

  • Update build versions to GA

    • Upon promotion of the final GA build, PRs for the the master and corresponding maintenance branch were created to update the build to the GA versions.
    • Submit these PRs now.

  • Make the Release Visible

    • Run the Publish Promoted Build job in Releng jenkins to make the promoted build visible on the download page.
      • releaseBuildID: the full id of the release build to publish, e.g. R-4.36-202505281830
  • The (still existing) I-Build jobs of that release can now be deleted (together with the associdated test jobs), because we are now sure a RC respins won't happen anymore.

Preparation for the next Release

  • After RC2 is promoted/published run the Prepare Next Development Cycle job
    • Review the Pull-Requests created by it in this eclipse.platform.releng.aggregator repository and all its submodules and complete the listed tasks.

Update the Build Calendar:

  • Create an issue and update the build calendar for the next GA release based on the Simultaneous Release schedule.
  • Each stream has its own page with a more detailed schedule.
  • List of people who can edit the calendar
    • Alexander Kurtakov(@akurtakov)
    • Gireesh Punathil
    • Rahul Mohanan

Update Splash Screen: