🐸 Froggit Repository Plugin
Un plugin Gradle pour simplifier l'ajout de dépôts Maven hébergés sur Froggit (GitLab self-hosted).
🚀 Installation
Ajoute le dépôt Froggit pour les plugins dans ton settings.gradle.kts
:
pluginManagement {
repositories {
maven(uri("https://lab.frogg.it/api/v4/projects/1980/packages/maven"))
}
}
Puis applique le plugin dans le build.gradle.kts
de ton projet :
plugins {
id("dev.arvernes.froggit-repo") version "<VERSION>"
}
📦 Utilisation
Ajoute un ou plusieurs dépôts Maven Froggit dans un build.gradle.kts
:
froggitRepositories(
projectIds = listOf(1980,1981),
tokenVarName = "MY_TOKEN_VAR"
)
🔐 Si la variable d'environnement ou de propriété
MY_TOKEN_VAR
est définie, le plugin ajoute automatiquement l’authentification avec un token GitLab.
🔐 Authentification
Le token utilisé doit être un token d’accès personnel GitLab avec les scopes suivants :
read_api
read_repository
Ces autorisations sont nécessaires pour accéder aux packages Maven privés via l’API GitLab.
💾 Où définir le token ?
Méthode recommandée (persistante et locale) :
# ~/.gradle/gradle.properties
MY_TOKEN_VAR=glpat-xxxxxxxxxxxxxxxxxxxx
Méthode alternative (volatile, utile en CI/CD) :
export MY_TOKEN_VAR=glpat-xxxxxxxxxxxxxxxxxxxx
⚙️ Comportement
- ✅ Le dépôt est toujours déclaré, même sans token (utile pour les projets publics).
- ⚠️ Un avertissement s’affiche si le token est manquant alors qu’une variable est spécifiée.
- 🔐 L’authentification est appliquée uniquement si le token est détecté.
🧪 Exemple complet
plugins {
id("dev.arvernes.froggit-repo") version "1.0.0"
}
repositories {
mavenFroggit(
projectIds = listOf(1978),
tokenVarName = "MAVEN_CONSUMER_TOKEN"
)
mavenCentral()
}