Arbeiten mit der Gradle-Registry

Authentifizierung bei GitHub Packages

Du benötigst ein Zugriffstoken, um private, interne und öffentliche Pakete zu veröffentlichen, zu installieren und zu löschen.

Du kannst ein personal access token (classic) verwenden, um dich bei GitHub Packages oder der GitHub-API zu authentifizieren. Wenn du ein personal access token (classic) erstellst, kannst du dem Token je nach Bedarf verschiedene Bereiche zuweisen. Weitere Informationen zu paketbezogenen Bereichen für ein personal access token (classic) findest du unter Informationen zu Berechtigungen für GitHub-Pakete.

Um dich bei einer GitHub Packages-Registrierung innerhalb eines GitHub Actions-Workflows zu authentifizieren, kannst du Folgendes verwenden:

• GITHUB_TOKEN, um Pakete zu veröffentlichen, die mit dem Workflowrepository verbunden sind.
• Ein personal access token (classic) mit mindestens dem read:packages-Bereich für die Installation von Paketen, die anderen privaten Repositorys zugeordnet sind (GITHUB_TOKEN kann verwendet werden, wenn das Repository Lesezugriff auf das Paket enthält. Weitere Informationen findest du unter Konfigurieren der Zugriffssteuerung und Sichtbarkeit von Paketen).

Weitere Informationen zum GITHUB_TOKEN, das in GitHub Actions-Workflows verwendet wird, findest du unter Verwenden von GITHUB_TOKEN für die Authentifizierung in Workflows. Weitere Informationen zur Verwendung GITHUB_TOKEN mit Gradle finden Sie unter Veröffentlichen Java Pakete mit Gradle.

Authentifizieren mit einem personal access token

Du musst ein personal access token (classic) mit den entsprechenden Bereichen verwenden, um Pakete in GitHub Packages zu veröffentlichen und zu installieren. Weitere Informationen finden Sie unter Einführung in GitHub-Pakete.

Sie können sich mit Gradle bei GitHub Packages authentifizieren, indem Sie entweder Ihre build.gradle-Datei (Gradle Groovy) oder Ihre build.gradle.kts-Datei (Kotlin DSL) bearbeiten, um Ihre personal access token (classic) einzufügen. Du kannst auch Gradle Groovy und Kotlin DSL konfigurieren, um ein einzelnes Paket oder mehrere Pakete in einem Repository zu erkennen.

Ersetzen Sie REGISTRY_URL durch die URL für die Maven-Registrierung Ihrer Instanz. Wenn die Unterdomänenisolation für deine Instanz aktiviert ist, verwende maven.HOSTNAME. Wenn Unterdomänenisolation für deine Instanz deaktiviert ist, verwende HOSTNAME/_registry/maven. Ersetzen Sie in beiden Fällen HOSTNAME durch den Hostnamen Ihrer GitHub Enterprise Server-Instanz.

Ersetzen Sie USERNAME durch Ihren GitHubBenutzernamen, TOKEN durch Ihr personal access token (classic), REPOSITORY durch den Namen des Repositorys, das das Paket enthält, das Sie veröffentlichen möchten, und OWNER durch den Namen des persönlichen Kontos oder der Organisation auf GitHub, dem bzw. der das Repository gehört. Da Großbuchstaben nicht unterstützt werden, müssen Sie Kleinbuchstaben für den Repositorybesitzer verwenden, auch wenn der GitHub Benutzer- oder Organisationsname Großbuchstaben enthält.

Beispiel für die Verwendung von Gradle Groovy für ein einzelnes Paket in einem Repository

plugins {
    id("maven-publish")
}
publishing {
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
            credentials {
                username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
                password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
            }
        }
    }
    publications {
        gpr(MavenPublication) {
            from(components.java)
        }
    }
}

Beispiel für die Verwendung von Gradle Groovy für mehrere Pakete im gleichen Repository

plugins {
    id("maven-publish") apply false
}
subprojects {
    apply plugin: "maven-publish"
    publishing {
        repositories {
            maven {
                name = "GitHubPackages"
                url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
                credentials {
                    username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
                    password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
                }
            }
        }
        publications {
            gpr(MavenPublication) {
                from(components.java)
            }
        }
    }
}

Beispiel für die Verwendung von Kotlin DSL für ein einzelnes Paket im gleichen Repository

plugins {
    `maven-publish`
}
publishing {
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
            credentials {
                username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
                password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
            }
        }
    }
    publications {
        register<MavenPublication>("gpr") {
            from(components["java"])
        }
    }
}

Beispiel für die Verwendung von Kotlin DSL für mehrere Pakete im gleichen Repository

plugins {
    `maven-publish` apply false
}
subprojects {
    apply(plugin = "maven-publish")
    configure<PublishingExtension> {
        repositories {
            maven {
                name = "GitHubPackages"
                url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
                credentials {
                    username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
                    password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
                }
            }
        }
        publications {
            register<MavenPublication>("gpr") {
                from(components["java"])
            }
        }
    }
}

Veröffentlichen eines Pakets

Standardmäßig veröffentlicht GitHub das Paket in ein vorhandenes Repository mit dem gleichen Namen wie das Paket. Zum Beispiel veröffentlicht GitHub ein Paket namens com.example.test im OWNER/testGitHub Packages Repository.

Nachdem Du ein Paket veröffentlicht hast, kannst Du das Paket auf GitHub ansehen. Weitere Informationen finden Sie unter Pakete anzeigen.

1. Authentifizieren bei GitHub Packages. Weitere Informationen findest Du unter Authentifizieren bei GitHub Packages.

2. Nachdem du dein Paket erstellt hast, kannst du das Paket veröffentlichen.

    gradle publish
   

Verwenden eines veröffentlichten Pakets

Wenn Sie ein veröffentlichtes Paket GitHub Packagesverwenden möchten, fügen Sie das Paket als Abhängigkeit hinzu, und fügen Sie das Repository zu Ihrem Projekt hinzu. Weitere Informationen findest du unter Deklarieren von Abhängigkeiten in der Gradle-Dokumentation.

1. Authentifizieren bei GitHub Packages. Weitere Informationen findest Du unter Authentifizieren bei GitHub Packages.

2. Füge die Paketabhängigkeiten deiner Build.gradle-Datei (Gradle Groovy) oder der Datei „Build.gradle.kts“ (Kotlin DSL) hinzu.

   Beispiel mit Gradle Groovy:

   dependencies {
       implementation 'com.example:package'
   }
   

   Beispiel für die Verwendung von Kotlin DSL:

   dependencies {
       implementation("com.example:package")
   }
   

3. Füge das Repository deiner Build.gradle-Datei (Gradle Groovy) oder der Datei „Build.gradle.kts“ (Kotlin DSL) hinzu.

   Beispiel mit Gradle Groovy:

   repositories {
       maven {
           url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
           credentials {
               username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
               password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
           }
      }
   }
   

   Beispiel für die Verwendung von Kotlin DSL:

   repositories {
       maven {
           url = uri("https://REGISTRY_URL/OWNER/REPOSITORY")
           credentials {
               username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
               password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
           }
       }
   }
   

Weiterführende Lektüre

• Arbeiten mit der Apache Maven-Registrierung
• Löschen und Wiederherstellen eines Pakets