Utilisation du registre Gradle

Authentification auprès de GitHub Packages

Vous avez besoin d’un jeton d’accès pour publier, installer et supprimer des packages.

Vous pouvez utiliser un jeton d’accès personnel (PAT) pour vous authentifier sur GitHub Packages ou l’API GitHub. Quand vous créez un jeton d’accès personnel, vous pouvez l’attribuer à différentes étendues en fonction de vos besoins. Pour plus d’informations sur les étendues liées aux packages pour un jeton PAT, consultez « À propos des autorisations de GitHub Packages ».

Pour vous authentifier sur un registre GitHub Packages dans un workflow GitHub Actions, vous pouvez utiliser :

• GITHUB_TOKEN pour publier des packages associés au dépôt du workflow.
• Un PAT avec au moins l’étendue packages:read pour installer des packages associés à d’autres dépôts privés (auxquels GITHUB_TOKEN ne peut pas accéder).

Pour plus d’informations sur le GITHUB_TOKEN utilisé dans les workflows GitHub Actions, consultez « Authentification dans un workflow ». Pour plus d’informations sur l’utilisation de GITHUB_TOKEN avec Gradle, consultez « Publication de packages Java avec Gradle ».

Authentification avec un jeton d’accès personnel

Vous devez utiliser un jeton d’accès personnel avec les étendues appropriées pour publier et installer des packages dans GitHub Packages. Pour plus d’informations, consultez « À propos de GitHub Packages ».

Vous pouvez vous authentifier auprès de GitHub Packages avec Gradle à l’aide de Gradle Groovy ou de Kotlin DSL en modifiant votre fichier build.gradle (Gradle Groovy) ou build.gradle.kts (Kotlin DSL) pour inclure votre jeton d’accès personnel. Vous pouvez également configurer Gradle Groovy et Kotlin DSL pour reconnaître un package unique ou plusieurs packages dans un dépôt.

Remplacez USERNAME par votre nom d’utilisateur GitHub, TOKEN par votre jeton d’accès personnel, REPOSITORY par le nom du dépôt contenant le package que vous souhaitez publier et OWNER par le nom du compte d’utilisateur ou d’organisation sur GitHub propriétaire du dépôt. Étant donné que les lettres majuscules ne sont pas prises en charge, vous devez utiliser des lettres minuscules pour le propriétaire du dépôt, même si le nom d’utilisateur ou d’organisation GitHub contient des lettres majuscules.

Exemple d’utilisation de Gradle Groovy pour un seul package dans un dépôt

plugins {
    id("maven-publish")
}
publishing {
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/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)
        }
    }
}

Exemple d’utilisation de Gradle Groovy pour plusieurs packages dans le même dépôt

plugins {
    id("maven-publish") apply false
}
subprojects {
    apply plugin: "maven-publish"
    publishing {
        repositories {
            maven {
                name = "GitHubPackages"
                url = uri("https://maven.pkg.github.com/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)
            }
        }
    }
}

Exemple d’utilisation de Kotlin DSL pour un seul package dans le même dépôt

plugins {
    `maven-publish`
}
publishing {
    repositories {
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/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"])
        }
    }
}

Exemple d’utilisation de Kotlin DSL pour plusieurs packages dans le même dépôt

plugins {
    `maven-publish` apply false
}
subprojects {
    apply(plugin = "maven-publish")
    configure<PublishingExtension> {
        repositories {
            maven {
                name = "GitHubPackages"
                url = uri("https://maven.pkg.github.com/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"])
            }
        }
    }
}

Publication d’un package

Par défaut, GitHub publie le package dans un dépôt existant portant le même nom que le package. Par exemple, GitHub publie un package nommé com.example.test dans le dépôt OWNER/test GitHub Packages.

Après avoir publié un package, vous pouvez l’afficher sur GitHub. Pour plus d’informations, consultez « Affichage de packages ».

1. Authentifiez-vous sur GitHub Packages. Pour plus d’informations, consultez « Authentification auprès de GitHub Packages ».

2. Après avoir créé votre package, vous pouvez publier le package.

   $ gradle publish

Utilisation d’un package publié

Pour utiliser un package publié à partir de GitHub Packages, ajoutez le package en tant que dépendance et ajoutez le dépôt à votre projet. Pour plus d’informations, consultez « Déclaration de dépendances » dans la documentation Gradle.

1. Authentifiez-vous sur GitHub Packages. Pour plus d’informations, consultez « Authentification auprès de GitHub Packages ».

2. Ajoutez les dépendances de package à votre fichier build.gradle (Gradle Groovy) ou build.gradle.kts (Kotlin DSL).

   Exemple d’utilisation de Gradle Groovy :

   dependencies {
       implementation 'com.example:package'
   }

   Exemple d’utilisation de Kotlin DSL :

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

3. Ajoutez le dépôt à votre fichier build.gradle (Gradle Groovy) ou build.gradle.kts (Kotlin DSL).

   Exemple d’utilisation de Gradle Groovy :

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

   Exemple d’utilisation de Kotlin DSL :

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

Pour aller plus loin

• « Utilisation du registre Apache Maven »
• « Suppression et restauration d’un package »