Skip to main content

Java-Pakete mit Gradle veröffentlichen

Du kannst Gradle verwenden, um Java-Pakete als Teil deines Workflows zur kontinuierlichen Integration (CI) in einer Registry zu veröffentlichen.

Einführung

Diese Anleitung zeigt, wie Du einen Workflow erstellst, der Java-Pakete in das GitHub Packages und das Maven Central Repository veröffentlicht. Mit einem einzelnen Workflow kannst Du Pakete in ein einzelnes oder in mehrere Repositorys veröffentlichen.

Voraussetzungen

Wir empfehlen Dir, ein grundlegendes Verständnis von Workflow-Dateien und Konfigurationsoptionen zu haben. Weitere Informationen findest du unter Informationen zu GitHub Actions.

Weitere Informationen zum Erstellen eines CI-Workflows für dein Java-Projekt mit Gradle findest du unter Erstellen und Testen von Java mit Gradle.

Vielleicht findest Du es auch hilfreich, ein grundlegendes Verständnis von Folgendem zu haben:

Informationen zur Paketkonfiguration

Die Felder groupId und artifactId in dem Abschnitt MavenPublication der Datei build.gradle erstellen einen eindeutigen Bezeichner für dein Paket, der von Registrierungen zum Verknüpfen deines Pakets mit einer Registrierung verwendet wird. Dies ähnelt den Feldern groupId und artifactId der Maven-Datei pom.xml. Weitere Informationen findest du in der Gradle-Dokumentation unter Maven-Veröffentlichungs-Plug-In.

Die Datei build.gradle enthält auch die Konfiguration für die Distributionsverwaltungsrepositorys, in denen Gradle Pakete veröffentlicht. Jedes Repository braucht einen Namen, eine Deployment-URL und Anmeldeinformationen zur Authentifizierung.

Pakete im „Maven Central Repository“ veröffentlichen

Jedes Mal, wenn Du ein neues Release erstellst, kannst Du einen Workflow anstoßen, um Dein Paket zu veröffentlichen. Der Workflow im folgenden Beispiel wird ausgeführt, wenn das release-Ereignis mit dem created-Typ ausgelöst wird. Der Workflow veröffentlicht das Paket im „Maven Central Repository“, sofern es die CI-Tests besteht. Weitere Informationen zum release-Ereignis findest du unter Ereignisse, die Workflows auslösen.

Du kannst ein neues Maven-Repository im Veröffentlichungsblock deiner Dateibuild.gradle definieren, das auf dein Paketrepository verweist. Wenn du die Bereitstellung für das Maven Central Repository beispielsweise über das OSSRH-Hostingprojekt durchgeführt hast, könnte deine Datei build.gradle ein Repository mit dem Namen "OSSRH" angeben.

groovy
plugins {
  ...
  id 'maven-publish'
}

publishing {
  ...

  repositories {
    maven {
      name = "OSSRH"
      url = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
      credentials {
        username = System.getenv("MAVEN_USERNAME")
        password = System.getenv("MAVEN_PASSWORD")
      }
    }
  }
}

Mit dieser Konfiguration kannst du einen Workflow erstellen, der dein Paket im Maven Central Repository veröffentlicht, indem du den gradle publish-Befehl ausführst. Im Deploy-Schritt musst du Umgebungsvariablen für den Benutzernamen und das Passwort oder für den Token festlegen, mit dem du Dich im Maven-Repository authentifizierst. Weitere Informationen findest du unter Erstellen und Verwenden verschlüsselter Geheimnisse.

YAML

# <a name="this-workflow-uses-actions-that-are-not-certified-by-github"></a>Dieser Workflow verwendet Aktionen, die nicht von GitHub zertifiziert sind.
# <a name="they-are-provided-by-a-third-party-and-are-governed-by"></a>Sie werden von einem Drittanbieter bereitgestellt und unterliegen
# <a name="separate-terms-of-service-privacy-policy-and-support"></a>separaten Nutzungsbedingungen, Datenschutzbestimmungen und Support
# <a name="documentation"></a>Onlinedokumentation.

# <a name="github-recommends-pinning-actions-to-a-commit-sha"></a>GitHub empfiehlt, Aktionen an einen Commit-SHA anzuheften.
# <a name="to-get-a-newer-version-you-will-need-to-update-the-sha"></a>Um eine neuere Version zu erhalten, musst du den SHA aktualisieren.
# <a name="you-can-also-reference-a-tag-or-branch-but-the-action-may-change-without-warning"></a>Du kannst auch auf ein Tag oder einen Branch verweisen, aber die Aktion kann sich ohne Vorwarnung ändern.

name: Publish package to the Maven Central Repository
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Java
        uses: actions/setup-java@v2
        with:
          java-version: '11'
          distribution: 'adopt'
      - name: Validate Gradle wrapper
        uses: gradle/wrapper-validation-action@e6e38bacfdf1a337459f332974bb2327a31aaf4b
      - name: Publish package
        uses: gradle/gradle-build-action@67421db6bd0bf253fb4bd25b31ebb98943c375e1
        with:
          arguments: publish
        env:
          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}

Dieser Workflow führt die folgenden Schritte aus:

  1. Checkt eine Kopie des Projekt-Repositorys aus.

  2. Richtet das Java JDK ein.

  3. Überprüft die Prüfsummen aller Gradle Wrapper JAR-Dateien, die im Repository vorhanden werden.

  4. Führt die Aktion gradle/gradle-build-action mit dem publish-Argument aus, um das OSSRH-Maven-Repository zu veröffentlichen. Die Umgebungsvariable MAVEN_USERNAME wird mit dem Inhalt deines OSSRH_USERNAME-Geheimnisses und die Umgebungsvariable MAVEN_PASSWORD mit dem Inhalt deines OSSRH_TOKEN-Geheimnisses festgelegt.

    Weitere Informationen zur Verwendung von Geheimnissen in deinem Workflow findest du unter Erstellen und Verwenden verschlüsselter Geheimnisse.

Pakete in der GitHub Packages veröffentlichen

Jedes Mal, wenn Du ein neues Release erstellst, kannst Du einen Workflow anstoßen, um Dein Paket zu veröffentlichen. Der Workflow im folgenden Beispiel wird ausgeführt, wenn das release-Ereignis mit dem created-Typ ausgelöst wird. Der Workflow veröffentlicht das Paket in GitHub Packages , wenn die CI-Tests bestanden wurden. Weitere Informationen zum release-Ereignis findest du unter Ereignisse, die Workflows auslösen.

Du kannst ein neues Maven-Repository im Veröffentlichungsblock deiner Dateibuild.gradle definieren, das auf GitHub Packages verweist. In dieser Repository-Konfiguration kannst du auch die in deinem CI-Workflow-Lauf eingestellten Umgebungsvariablen nutzen. Du kannst die Umgebungsvariable GITHUB_ACTOR als Benutzername verwenden und die Umgebungsvariable GITHUB_TOKEN mit deinem GITHUB_TOKEN-Geheimnis festlegen.

Das GITHUB_TOKEN-Geheimnis wird jedes Mal auf ein Zugriffstoken für das Repository festgelegt, wenn ein Auftrag in einem Workflow beginnt. Die Berechtigungen für dieses Zugriffstoken müssen in der Workflowdatei festgelegt werden, um Lesezugriff auf den contents-Bereich und Schreibzugriff auf den packages-Bereich zu gewähren. Weitere Informationen findest du unter Authenticating with the GITHUB_TOKEN („Authentifizieren mit dem GITHUB_TOKEN“).

Wenn deine Organisation beispielsweise „octocat“ und dein Repository „hello-world“ heißt, ähnelt die GitHub Packages-Konfiguration in build.gradle dem folgenden Beispiel.

groovy
plugins {
  ...
  id 'maven-publish'
}

publishing {
  ...

  repositories {
    maven {
      name = "GitHubPackages"
      url = "https://maven.pkg.github.com/octocat/hello-world"
      credentials {
        username = System.getenv("GITHUB_ACTOR")
        password = System.getenv("GITHUB_TOKEN")
      }
    }
  }
}

Mit dieser Konfiguration kannst du einen Workflow erstellen, der dein Paket in GitHub Packages veröffentlicht, indem du den gradle publish-Befehl ausführst.

YAML

# <a name="this-workflow-uses-actions-that-are-not-certified-by-github"></a>Dieser Workflow verwendet Aktionen, die nicht von GitHub zertifiziert sind.
# <a name="they-are-provided-by-a-third-party-and-are-governed-by"></a>Sie werden von einem Drittanbieter bereitgestellt und unterliegen
# <a name="separate-terms-of-service-privacy-policy-and-support"></a>separaten Nutzungsbedingungen, Datenschutzbestimmungen und Support
# <a name="documentation"></a>Onlinedokumentation.

# <a name="github-recommends-pinning-actions-to-a-commit-sha"></a>GitHub empfiehlt, Aktionen an einen Commit-SHA anzuheften.
# <a name="to-get-a-newer-version-you-will-need-to-update-the-sha"></a>Um eine neuere Version zu erhalten, musst du den SHA aktualisieren.
# <a name="you-can-also-reference-a-tag-or-branch-but-the-action-may-change-without-warning"></a>Du kannst auch auf ein Tag oder einen Branch verweisen, aber die Aktion kann sich ohne Vorwarnung ändern.

name: Publish package to GitHub Packages
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-java@v2
        with:
          java-version: '11'
          distribution: 'adopt'
      - name: Validate Gradle wrapper
        uses: gradle/wrapper-validation-action@e6e38bacfdf1a337459f332974bb2327a31aaf4b
      - name: Publish package
        uses: gradle/gradle-build-action@67421db6bd0bf253fb4bd25b31ebb98943c375e1
        with:
          arguments: publish
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Dieser Workflow führt die folgenden Schritte aus:

  1. Checkt eine Kopie des Projekt-Repositorys aus.

  2. Richtet das Java JDK ein.

  3. Überprüft die Prüfsummen aller Gradle Wrapper JAR-Dateien, die im Repository vorhanden werden.

  4. Führt die Aktion gradle/gradle-build-action mit dem publish-Argument aus, um GitHub Packages zu veröffentlichen. Die Umgebungsvariable GITHUB_TOKEN wird mit dem Inhalt des GITHUB_TOKEN-Geheimnisses festgelegt. Der Schlüssel permissions gibt den Zugriff an, den das GITHUB_TOKEN-Geheimnis erteilt.

    Weitere Informationen zur Verwendung von Geheimnissen in deinem Workflow findest du unter Erstellen und Verwenden verschlüsselter Geheimnisse.

Pakete im Maven Central Repository und in der GitHub Packages veröffentlichen

Du kannst deine Pakete sowohl im Maven Central Repository als auch in der GitHub Packages veröffentlichen, indem du für jede Registrierung deine Datei build.gradle konfigurierst.

Stelle sicher, dass deine Datei build.gradle ein Repository sowohl für dein GitHub-Repository als auch für deinen Maven Central Repository-Anbieter enthält.

Wenn du die Bereitstellung für das Central Repository beispielsweise über das OSSRH-Hostingprojekt durchgeführt hast, möchtest du sie möglicherweise in einem Distributionsverwaltungsrepository festlegen, indem du für name``OSSRH angibst. Wenn du GitHub Packages bereitstellst, möchtest du sie möglicherweise in einem Distributionsverwaltungsrepository mit name festgelegt auf GitHubPackages angeben.

Wenn deine Organisation beispielsweise „octocat“ und dein Repository „hello-world“ heißt, ähnelt die Konfiguration in build.gradle dem folgenden Beispiel.

groovy
plugins {
  ...
  id 'maven-publish'
}

publishing {
  ...

  repositories {
    maven {
      name = "OSSRH"
      url = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
      credentials {
        username = System.getenv("MAVEN_USERNAME")
        password = System.getenv("MAVEN_PASSWORD")
      }
    }
    maven {
      name = "GitHubPackages"
      url = "https://maven.pkg.github.com/octocat/hello-world"
      credentials {
        username = System.getenv("GITHUB_ACTOR")
        password = System.getenv("GITHUB_TOKEN")
      }
    }
  }
}

Mit dieser Konfiguration kannst du einen Workflow erstellen, der dein Paket in dem Maven Central Repository und in der GitHub Packages veröffentlicht, indem du den gradle publish-Befehl ausführst.

YAML

# <a name="this-workflow-uses-actions-that-are-not-certified-by-github"></a>Dieser Workflow verwendet Aktionen, die nicht von GitHub zertifiziert sind.
# <a name="they-are-provided-by-a-third-party-and-are-governed-by"></a>Sie werden von einem Drittanbieter bereitgestellt und unterliegen
# <a name="separate-terms-of-service-privacy-policy-and-support"></a>separaten Nutzungsbedingungen, Datenschutzbestimmungen und Support
# <a name="documentation"></a>Onlinedokumentation.

# <a name="github-recommends-pinning-actions-to-a-commit-sha"></a>GitHub empfiehlt, Aktionen an einen Commit-SHA anzuheften.
# <a name="to-get-a-newer-version-you-will-need-to-update-the-sha"></a>Um eine neuere Version zu erhalten, musst du den SHA aktualisieren.
# <a name="you-can-also-reference-a-tag-or-branch-but-the-action-may-change-without-warning"></a>Du kannst auch auf ein Tag oder einen Branch verweisen, aber die Aktion kann sich ohne Vorwarnung ändern.

name: Publish package to the Maven Central Repository and GitHub Packages
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
    steps:
      - uses: actions/checkout@v2
      - name: Set up Java
        uses: actions/setup-java@v2
        with:
          java-version: '11'
          distribution: 'adopt'
      - name: Validate Gradle wrapper
        uses: gradle/wrapper-validation-action@e6e38bacfdf1a337459f332974bb2327a31aaf4b
      - name: Publish package
        uses: gradle/gradle-build-action@67421db6bd0bf253fb4bd25b31ebb98943c375e1
        with:
          arguments: publish
        env: 
          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Dieser Workflow führt die folgenden Schritte aus:

  1. Checkt eine Kopie des Projekt-Repositorys aus.

  2. Richtet das Java JDK ein.

  3. Überprüft die Prüfsummen aller Gradle Wrapper JAR-Dateien, die im Repository vorhanden werden.

  4. Führt die Aktion gradle/gradle-build-action mit dem publish-Argument aus, um die Veröffentlichung in dem OSSRH-Maven-Repository und in der GitHub Packages auszuführen. Die Umgebungsvariable MAVEN_USERNAME wird mit dem Inhalt deines OSSRH_USERNAME-Geheimnisses und die Umgebungsvariable MAVEN_PASSWORD mit dem Inhalt deines OSSRH_TOKEN-Geheimnisses festgelegt. Die Umgebungsvariable GITHUB_TOKEN wird mit dem Inhalt des GITHUB_TOKEN-Geheimnisses festgelegt. Der Schlüssel permissions gibt den Zugriff an, den das GITHUB_TOKEN-Geheimnis erteilt.

    Weitere Informationen zur Verwendung von Geheimnissen in deinem Workflow findest du unter Erstellen und Verwenden verschlüsselter Geheimnisse.