Release process - eclipse-capella/capella GitHub Wiki

Current projects under Capella, with corresponding releases.

• https://projects.eclipse.org/projects/polarsys.capella

• https://projects.eclipse.org/projects/polarsys.kitalpha

• https://projects.eclipse.org/projects/modeling.emf.diffmerge

• https://projects.eclipse.org/projects/modeling.amalgam

• https://projects.eclipse.org/projects/modeling.emf.egf

Create Release pages

Connect to corresponding Eclipse project page

On Committers section, if release not yet appearing in releases page, click on Create a new release Choose the targetted Date and version Inspire from previous release for all fields (see the previous major or minor page as content is different between major/minor)

Create upcoming milestones on Github repositories

Go to Github milestones page and create releases, https://github.com/eclipse-capella/capella/milestones

Github: Update fixed issues with the target version

Go to https://github.com/eclipse-capella/capella/commits/master/ and close all fixed issues since last release and attach them to the corresponding fixed version. (This is faster and safer to do it once per release than asking to all contributors to do it)

Release review

Once per year, preferably on major releases (this step is subject to change each year, follow process https://www.eclipse.org/projects/handbook if updated)

• Click on "Schedule a review" on the release page This will create a page https://projects.eclipse.org/projects/polarsys.polarsys.capella/reviews/1.4.0-release-review

• Click on "Eclipse Management Organisation" to send a mail and schedule a Review date

• At same time, create a mail to [email protected] (Capella/Kitalpha) or ([email protected] for EGF/Diffmerge/Amalgam) to approve the Release page; ex: [polarsys-pmc] Capella 5.2.0 Release Review materials approval Register to mailing list to be able to send a mail.

• Wait PMC Polarsys anwser to make them reply +1

• Wait mails becomes visible on: https://www.eclipse.org/lists/polarsys-pmc/threads.html

• And if not yet done by Eclipse team, just inform about the +1 done in the gitlab release review issue
  ex: https://gitlab.eclipse.org/eclipsefdn/emo-team/emo/-/issues/32#note_10415

• When review is approved, official communication can be proceed.

Make sure the releases are ready

• Update target platforms to refer to official releases of dependencies (for Capella, make sure to publish kitalpha first)

  • https://github.com/eclipse-capella/capella/tree/master/releng/plugins/org.polarsys.capella.targets/full

  • https://github.com/eclipse-kitalpha/kitalpha/tree/master/releng/plugins/org.polarsys.kitalpha.releng.targets

  • https://github.com/eclipse-diffmerge/org.eclipse.emf.diffmerge.core/tree/master/releng/org.eclipse.emf.diffmerge.target

  • https://github.com/eclipse-amalgam/amalgam/tree/master/releng/org.eclipse.amalgam.releng/target_platforms

• Migrate and refresh representations of IFE sample project

• Update Releases and API notes embedded section

  • https://github.com/eclipse-capella/capella/tree/master/doc/plugins/org.polarsys.capella.doc/html/Release%20note

  • https://github.com/eclipse-capella/capella-tools/tree/api-gen

Publish release download.eclipse

• Create a release in Github (on the release page (Code > Release), click on Draft a new release. Choose a commit (or a previously created tag), and fill description inspiring from previous releases

• Create the Release Note on the Capella wiki

• Promote the build to copy binaries to download.eclipse.org/

Only the master branch are signed digitally, so don't promote pull requests artifacts

• https://ci.eclipse.org/kitalpha/job/kitapha_release/

• https://ci.eclipse.org/capella/job/promote-capella-product/

• https://ci.eclipse.org/capella/job/promote-capella-studio/

• https://ci.eclipse.org/diffmerge/job/diffmerge-promote/

• https://ci.eclipse.org/amalgam/job/amalgam-promote/

• https://ci.eclipse.org/egf/job/Release/

Communication

• Promote IFE sample from git to download.eclipse.org by editing job config first and run https://ci.eclipse.org/capella/view/Capella-Publish/job/promote-capella-git-samples/

• Clone repository site web Capella ( https://github.com/eclipse-capella/capella-website )

  • Migrate samples \resources\samples and push them to Git
  • Update sample links into download.html (just update versions, and use download.eclipse links)
  • Promote samples to download.eclipse.org editing config and using https://ci.eclipse.org/capella/view/Capella-Publish/job/promote-web-git-samples/
  • If any changes in IFE or docgen, generate IFE xhtml
    • Install xhtml dropins,
    • in capella, look for delimiter preference, and enable unix
    • import and open the sample model IFE and generate HTML by right clicking on the root element under the aird file. and put it in \capella\resources\doc of the website repository

• Update eclipse.org/capella and eclipse.org/kitalpha websites

  • Clone repository du site web Capella (https://github.com/eclipse-capella/capella-website)

  • Modify page Download (fichier json a mettre a jour, les liens de téléchargement et les miroirs eclipse)

  • After merge, it takes around 10min to make it visible on website (several mirrors have to be updated)

  • Update Kitalpha site (https://github.com/eclipse/kitalpha-website) (normally nothing now)

• Update Wikipedia

  • Modify pages Wikipédia FR et EN de Capella (mostly release numbers on the right pane)

• Mailing list

  • Send mail to capella-dev@eclipse.org https://www.eclipse.org/lists/capella-dev/msg01065.html

• Post on social networks

  • https://forum.mbse-capella.org/t/capella-5-2-0-has-been-released/5141

  • https://www.linkedin.com/in/capella-mbse-tool/

  • https://www.linkedin.com/posts/ganshaymsinh-devda-867a364_download-activity-6879448826323771392-kP4V

Bump to new release

At some point, bump code to new release.

https://github.com/eclipse-capella/capella/wiki/Development-How-To/_edit#bump-to-new-release