Publishing to repo.eclipse.org using GitHub Actions

This guide outlines how to publish Maven-based Eclipse projects directly to repo.eclipse.org using GitHub Actions.

Prerequisites

• Account and namespace already claimed. Open a HelpDesk Issue

• Publishing credentials stored as GitHub secrets

This is the list of secrets needed to deploy to repo.eclipse.org declared in GitHub organization as secrets.

• REPO_TOKEN_USERNAME
• REPO_TOKEN_PASSWORD

Otterdog configuration:

e.g: https://github.com/eclipse-cbi/.eclipsefdn/blob/main/otterdog/eclipse-cbi.jsonnet

secrets+: [
    orgs.newOrgSecret('REPO_TOKEN_USERNAME') {
      value: "vault:<project_id>/repo.eclipse.org/token-username",
    },
    orgs.newOrgSecret('REPO_TOKEN_PASSWORD') {
      value: "vault:<project_id>/repo.eclipse.org/token-password",
    },
  ],

Maven Configuration (pom.xml)

A distribution management section that defines the repository IDs, names and URLs for releases and snapshots must be added.

The repository names must be adapted for each project.

Format:

• <project_shortname>-maven2-releases
• <project_shortname>-maven2-snapshots

E.g. the project short name for project technology.cbi is cbi.

Example for project technology.cbi.

<distributionManagement>
  <repository>
    <id>repo.eclipse.org</id>
    <name>Eclipse CBI Nexus Repository - Releases</name>
    <url>https://repo.eclipse.org/content/repositories/cbi-maven2-releases/</url>
  </repository>
  <snapshotRepository>
    <id>repo.eclipse.org</id>
    <name>Ecilpse CBI Nexus Repository - Snapshots</name>
    <url>https://repo.eclipse.org/content/repositories/cbi-maven2-snapshots/</url>
  </snapshotRepository>
</distributionManagement>

GitHub Actions Workflow Example

Example of snapshot deployment:

name: Publish snapshot packages to repo.eclipse.org
on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
  workflow_dispatch:

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - name: Set up repo.eclipse.org Repository
        uses: actions/setup-java@de7274f081f381c8f8158605e0321c36c376e2e6 # v6.0.1
        with:
          java-version: '21'
          distribution: 'temurin'
          server-id: repo.eclipse.org
          server-username: MAVEN_USERNAME
          server-password: MAVEN_PASSWORD
      - name: Publish package
        run: mvn -P release --batch-mode deploy
        env:
          MAVEN_USERNAME: ${{ secrets.REPO_TOKEN_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.REPO_TOKEN_PASSWORD }}

Best Practices

• Sign all artifacts (even on snapshots)