Revision as of 11:28, 21 September 2022

The Eclipse Common Build Infrastructure (CBI) is an initiative combining infrastructure, services, technologies and best practices for building, testing and delivering software at the Eclipse Foundation.

Goals

Primary goals of the CBI initiative are:

• Make it easy for anyone to contribute to Eclipse projects.
• Make it easy for projects to follow open governance and transparency best practices.
• Provide a set of industry-grade services (or integration with some widely adopted 3rd party services) for building and distributing Eclipse projects.

Asking for Help

• Need help actually building your code: ask your project mentors, or ask on the Common Build mailing list (cbi-dev). There are no dumb questions.
• Subscribe to cbi-dev here: https://dev.eclipse.org/mailman/listinfo/cbi-dev

Service Level Agreement (SLA)

Most CBI services are Tier 2 - Best Effort, which means they are expected to be available at all times, and rapid restoration can be expected in the event of an outage. Eclipse Strategic Members can contact Webmaster in certain cases of off-hours support.

Please see IT_SLA for more information on the Eclipse Foundation IT Services SLA.

Security

The Eclipse Foundation has authored an Open Source Software Supply Chain Best Practices document. We highly recommend Eclipse OSS projects read, understand and adopt these best practices as part of their role in the Supply Chain.

https://github.com/eclipse-cbi/best-practices/blob/main/software-supply-chain/osssc-best-practices.md

Provided Services

CI Environment (Jenkins)

We provide dedicated Jenkins instances to projects. See also Jenkins.

Jenkins is a continuous integration (CI) server used on Eclipse Foundation servers for Eclipse projects as part of the Common Build Infrastructure (CBI). Jenkins instances are maintained by the Eclipse Webmasters/Release Engineers.

List of Jenkins Instances Per Project (JIPP):

• https://ci.eclipse.org/

Requesting a JIPP instance

Please file a ticket to request your project's own instance. Please ensure your project lead can +1 the request. Please specify if you wish to grant write access to your download area and/or code repositories.

Security issues
There may be security issues related to using the Gerrit plugin, more especially when allowing the CI system to write directly to the code repos and downloads area. If you request plugins other than those installed by default, webmasters may not be able to help troubleshoot any issues that you may encounter with your instance.

What's provided?

Each Eclipse Project has access to one Jenkins instance (JIPP), including the following:

• (1) Jenkins instance, with (1) Resources Pack (see below)
  • Membership-sponsored projects may allocate more resources (see below)
• Digital signing Service: Java JAR, Java Cryptography Extensions, Windows Portable Executable with Microsoft Authenticode, macOS application bundles.
• Packaging service: Apple Disk Image (.dmg), Linux Flatpak
• Disk space: Ephemeral for builds, permanent for release builds.
• (1) 1vCPU/3.75G/30G Linux Virtual Server (if needed) (courtesy of Microsoft Azure). Projects sponsored by Strategic Members can engage with the Foundation to get out of spec Virtual Server.
• Access to worldwide download mirrors

Additional Resource Packs

Each Eclipse Project has access to one Resources Pack for building. For some projects, that may not be enough. Projects sponsored by Eclipse Membership (via Project Lead) have additional Packs, based on membership level. These Packs can be allocated to projects. See the Jenkins wiki page to see how packs translate to Jenkins builds.

• Some resources are only available to Enterprise and Strategic members.
• Enterprise and Strategic members can engage with the Foundation to acquire additional Packs.

Resource Packs Included in Membership

Eclipse Foundation Member Organizations have access to Resource Packs based on their membership level.

Windows and macOS agents
Note that Windows and macOS agents (shared and headless - not suitable to run UI tests) can be added to your Jenkins instance. In this case, each shared headless agent count for 1 resource packs. These agents have common dependencies like JDK, Maven, etc installed. If your build requires specific/special dependencies you might need to setup your own external build agent instead.

Assigning Resource Packs to a Project

Resource Packs are assigned by Member organizations of the Eclipse Foundation to Eclipse Projects they sponsor. Packs are assigned as a whole to a single project (i.e., can’t split Packs across multiple projects). A member can assign several packs to a single project.

Important
When asking for packs for your project, please ensure that project leads and your organization representatives are copied to the GitLab ticket. We require approval from project leads but assume immediate approval from organization representatives. We strongly advise you seek authorization internally to your organization before opening such a request though. Should conflictual requests arise, the organization representatives will be asked to actively arbitrate.

To assign a pack to a project, please file a ticket.

By default, resource packs are assigned build agents. In some cases, it may be required to scale up the Jenkins master. In such case, we can allocate resource packs to the master instance.

Sponsored Projects

We maintain a public API of sponsored projects. Organizations can check how many Resource Packs they have left for project sponsoring on the membership portal.

CI Environment (Third-party)

If you host your Eclipse project git repository at GitHub, we also support some third-party services:

• CircleCI.
• Azure Pipelines.
• TravisCI. We do no longer support Travis CI, see the announcement here: https://www.eclipse.org/lists/cross-project-issues-dev/msg18647.html

If an environment is not listed in the unsupported list, you can ask whether it can be supported by opening a bug.

Third party build services (e.g., CircleCI) limitations
The Eclipse Foundation's IT Team is responsible for the credentials (OSSRH, SSH and GPG keys...) it creates for projects. Keeping track of where credentials are disseminated is crucial for security reasons. As long as we have no automation in place to set/update/remove credentials on 3rd party build services, we don't put any credential on such services. For instance, it means that you can't use them to publish to Maven Central, or to upload build results to download.eclipse.org.

GitHub and Bot Accounts

The Eclipse Foundation can create a bot user that can be used from your Jenkins (JIPP) instance to build branches and pull requests, push, tag, and comment on the repo.

We don't share the credentials of those bots for external usage (e.g., to use it with a private, behind firewall Jenkins instance, or with third-party services). Those bots have the same set of permissions as a committer and it would be against the Eclipse Development Process to give those permissions to anybody. Likewise, we don't grant any elevated permissions on repositories or organizations to any other bot account.

Webhooks

However, we can setup webhooks for you. We create webhooks that can only receive the following events:

• Branch or tag creation (Branch or tag created)
• Branch or tag deletion (Branch or tag deleted)
• Pull requests (Pull request opened, closed, reopened, edited, assigned, unassigned, review requested, review request removed, labeled, unlabeled, synchronized, ready for review, locked, or unlocked)
• Pushes (Git push to a repository)

See the GitHub developer documentation for more information.

Personal Access Token

We can also create personal access token for the bot account. We create tokens with only the following scopes:

• repo:status
• repo_deployment
• write:discussion

See the GitHub developer documentation about scopes and OAuth for more information.

Getting admin permissions on project's GitHub repositories

Project leads may require admin level access to their project's GitHub repositories. If that is the case, please open a new bug with your request. To be eligible to such permission level, your project must be in the mature phase and the request shall be highly motivated, so please tell us why you need that access (this information will be handy when sorting out the more general solution). Usually, admin permissions will be assigned temporarily.

Docker Hub

The Eclipse Foundation owns the eclipse organization and a couple of other project specific organizations at https://hub.docker.com. You can ask to get a repository being created on one of these organizations. We will set permissions so that committers have write access to this repo (you will need to share your Docker Hub ID with us).

You can also ask us to create a project specific organization. The organization name needs to follow the pattern eclipse<projectname>.

Note that we don't grant admin permissions on any Eclipse Foundation owned organization. We recognize that this means that you will have to go through us for all new repo creation, but we can't grant organizations-wide admin permission assigned to committers for security reasons.

In all cases, requests should be directed to the GitLab HelpDesk.

DockerHub policy changes (March 2021)
DockerHub is currently changing its policy regarding the number of free members inside an organization. As such, the rules above will probably need to evolve in the near future. See https://www.eclipse.org/lists/eclipse.org-committers/msg01273.html and https://bugs.eclipse.org/559659 for details.

Nexus/Maven repository

See Services/Nexus.

Signing tool

• Maven plugins for signing artifacts
• On demand signing tool

Eclipse Platform / plugins specific tooling

CBI license bundle

We offer a P2 repository containing the `org.eclipse.license` bundle which is located at:

   http://download.eclipse.org/cbi/updates/license/

This URL is a composite P2 repo containing the license bundle.

If you use Tycho you can add the p2 repo to the <repositories> section of your pom.xml file. Something similar to this:

    <repository>
      <id>license-feature</id>
      <url>http://download.eclipse.org/cbi/updates/license/</url>
      <layout>p2</layout>
    </repository>

In any particular feature which you need the license you can use the usual feature.xml section:

<?xml version="1.0" encoding="UTF-8"?>
<feature
      id="org.eclipse.help"
      label="%featureName"
      version="2.0.0.qualifier"
      provider-name="%providerName"
      plugin="org.eclipse.help.base"
      license-feature="org.eclipse.license"
      license-feature-version="1.0.0.qualifier"/> 
....

p2 repo checks

A set of "tests" which create reports or can be ran as unit tests that check to correctness of p2 repositories. That is partially just "correctness" in general (such as, that jars are signed, etc.) but more so that repositories conform to the requirements of the Eclipse Simultaneous release (such as, that jars have correct "Provider names", licenses, etc.). For more information, see See CBI/p2repoAnalyzers/Repo Reports.

p2 repo aggregator

A tool to combine several p2 repositories. Among other things, it makes sure they all have consistent constraints (that is, can be "installed together") unlike a raw p2 mirror task. For more information see CBI/aggregator.

Resources

• cbi-dev
• See our Frequently Asked Question list