Builds.md

Building Releases and Milestones

1. Tag the current main branch locally.
   git tag v2.31.0.M3 or git tag v2.31.0

2. Run the Full Deploy Job

   • For milestones run the xtext-monorepo-full-deploy-milestone job and select the milestone postfix (M1, M2, ...) as the RELEASE_TYPE parameter.
   • For releases run the xtext-monorepo-full-deploy-release Job.

3. Wait for the job to finish
   Check the Update Site and Drop dirs to contain the new Milestone or Release

   • For milestones https://download.eclipse.org/modeling/tmf/xtext/updates/milestones/ and https://download.eclipse.org/modeling/tmf/xtext/downloads/drops/
   • For releases https://download.eclipse.org/modeling/tmf/xtext/updates/releases/ and https://download.eclipse.org/modeling/tmf/xtext/downloads/drops/

4. Promote staged milestone/release on s01.oss.sonatype.org. Can only be done by Xtext release engineer with the right credentials at sonatype

   • Log in with your sonatype user.
   • Select Staging Repositories
   • Search for orgeclipsextext-NNNN and orgeclipsextend-NNNN with status open
   • Select both and perform the Close toolbar action
   • Wait until the checks have run successfully
   • Select both repositories again the perform the Release toolbar action

5. Contribute milestone / release to Simrel Aggregation Build

   • Clone / pull [email protected]:eclipse-simrel/simrel.build.git
   • Edit tmf-xtext.aggrcon and enter new repo path and version numbers.
   • Create a commit
   • Create a pr at github
   • Submit the pr

6. Update and publish Release Notes (for Releases only)

   • Create and review release notes (https://github.com/eclipse/xtext-website/tree/main/xtext-website/_posts/releasenotes and https://github.com/eclipse/xtext-website/tree/main/xtend-website/_posts/releasenotes)
   • For committer activity count git shortlog -s -n -e v<PREV_RELEASE>..v<NEW_RELEASE>
   • Remove published: false from release post
   • Create PR to merge branch main into published
   • Merge the PR
   • Wait for the website-deploy to finish. Shortly after the new Release Notes should pop up on the Xtext website and the Xtend website.

7. Update Marketplace entries (for Releases only)

   • Market place entry for Xtext
   • Market place entry for Xtend
   • For each update the properties:
     • Version Number
     • Supported Eclipse Release(s)
   • Click 'Save item to list' AND 'Save' afterwards - otherwise nothing will be saved.
   • Update Composite Repository for Eclipse Marketplace
     • In repository https://github.com/xtext/xtext-p2-orbit update files
       • updates/composite/marketplace/compositeArtifacts.xml
       • updates/composite/marketplace/compositeContent.xml
     • Run job update-composite-sites

8. Check availability of artifacts on Maven Central

   • It can take some hours until the artifacts are mirrored to Maven Central. Note: search.maven.org might not show the new release immediately when it is available. Check the availability of the artifacts for example with mvn dependency:get -U -DgroupId=org.eclipse.xtext -DartifactId=org.eclipse.xtext -Dversion=<VERSION>

9. Push the tag. git push origin <tag_name>

10. As soon as Maven Central is updated - send notifications

    • Newsgroup / Forum
    • Mailing list
    • Gitter
    • Ecliape Chat / matrix.eclipse.org
    • Twitter

11. Bump the version number (for Releases only)

    • run the scripts/fixVersions.sh -f '<old-version> e.g ./scripts/fixVersions.sh -f '2.31.0'.
    • commit and pull request the changed files

12. Bootstrap the main branch against new release (for Releases only)

    • Edit the xtend-maven-plugin-version property in pom.xml to contain the created release/milestone version and commit and pr the change.

13. xtext-apidiff (for Releases only)

    • adapt https://github.com/xtext/xtext-apidiff/blob/master/create-api-diff.sh
    • adapt Jenkins Configuration https://github.com/xtext/xtext-apidiff/blob/master/Jenkinsfile

14. Add / Update xtext-reference-projects (for Releases only)

    • should be done in the days after the release
    • import the root (only) into your Xtext dev env
    • adapt the current versions to use the current release in poms/build.gradle/target files.
    • commit and pr these changes.
    • edit and run the scripts in the launch folder.
    • create new scripts in the scripts folder.
    • adapt the Jenkins files and the Github action to make use of the new scripts.
    • commit and pr the adaptations

15. TODOs

    • create new target for the current eclipse release once it is out
    • adapt latest target to use new orbit / I-builds / eclipse release alias once available
    • prepare release notes and website changes for next release