RRZE – Projekte & Prozesse (P&P)

Das Blog der RRZE Stabsstelle "Projekte & Prozesse"

Content

Grails Plugins in eigenem Maven Repository verwalten / Manage Grails Plugins in own Maven Repository

English Version

In diesem Beitrag zeige ich kurz wie man Grails 2 Plugins als Releases in einem eigenen Maven Repository wie Archiva oder Artifactory verwalten kann. Dafür sind grundsätzlich zwei seperate Konfigurationen für Upload und Download vom Repository nötig.

Upload

Für das Releasen neuer Versionen in das eigene Repository bietet Grails 2 das Release Plugin, das man allerdings erst selbst nachinstallieren muss:
[bash]
grails install-plugin release
[/bash]

Die nötige Konfiguration dazu wird in die ~/.grails/settings.groovy ausgelagert. Einträge in dieser Datei gelten für alle Grails Projekte und sind äquivalent zu Einträgen in der BuildConfig.groovy.

Hier ein Beispiel zur Einrichtung von Archiva als Release Repository:
[groovy]
/*
* THIS IS FOR UPLOADING TO THE REPO (via release plugin)
* To use this do:
* grails2 install-plugin release
*/
grails.project.repos.default = “rrzeArchiva”

grails.project.repos.rrzeArchiva.url = “http://REPOSITORY:PORT/archiva/repository/internal/”
grails.project.repos.rrzeArchiva.username = “USERNAME”
grails.project.repos.rrzeArchiva.password = “PASSWORD”

// disable nagging about not having committed all changes…
grails.release.scm.enabled = false
[/groovy]

Das Beispiel Konfiguriert das rrzeArcchiva Repository als Default für Uploads und deaktiviert die SVN Überprüfung für nicht eingecheckte Änderungen.

Fertig.

Neue Releases können dann mit folgenden Build Targets ins Repository geladen bzw. in den lokalen Maven Cache installiert werden.
[bash]
grails maven-deploy
grails maven-install
[/bash]

Download

Für den automatischen Download von Plugins aus dem Repository sind folgende Einträge in der BuildConfig.groovy des Projektes nötig.
[groovy]
grails.project.dependency.resolution = {
repositories {
mavenLocal()
mavenRepo name:”rrzeArchiva”, root:”http://REPOSITORY:PORT/archiva/repository/internal”
}
plugins {
runtime “:ppsa-menu:latest.release”
}
}
[/groovy]

Der Repositories Abschnitt Konfiguriert den lokalen Maven Cache und das Archiva Repository als zu durchsuchende Quellen für Plugin Abhängigkeiten.
Die Plugin Abhängigkeiten selbst werden im eigenen Abschnitt Plugins verwaltet. Der Beispieleintrag lädt immer die aktuellste Version des Plugins ppsa-menu.

Eigentlich würde das nun schon reichen, um Plugins auf dem Repository zu installieren.

Die allermeisten internen Repositories werden jedoch noch zusätzlich eine Authentifizierung erfordern. Hierfür muss noch der folgende Eintrag zur ~/.grails/settings.groovy hinzugefügt werden.
[groovy]
/*
* THIS IS FOR DOWNLOADING FROM THE REPO
* To use this add this to your BuildConfig.groovy:
* mavenRepo name:”rrzeArchiva”, root:”http://REPOSITORY:PORT/archiva/repository/internal”
*/
grails.project.ivy.authentication = {
credentials {
realm = “Repository Archiva Managed internal Repository”
host = “REPOSITORY(ohne Port!)”
username = “USERNAME”
password = “PASSWORD”
}
}
[/groovy]

—- WICHTIG —-

Für Archiva muss der Realm wie angegeben konfiguriert werden. Sonst geht nix!

Außerdem muss der Host hier ohne Port angegeben werden. Wenn das Archiva also z.B. auf Port 8080 läuft ist diese Angabe hier wegzulassen.
—- WICHTIG —-

Managing Grails Plugins in own Maven Repository


 

In this post I will briefly show how to manage Grails 2 Plugins as releases in an own Maven Repository such as Archiva or Artifactory. Therefore basically two separate configurations for Upload and Download from the repository are needed.

Upload

To release new versions in the own repository Graisl 2 offers the Release Plugin, which though must be installed additionally by yourself:
[bash]
grails install-plugin release
[/bash]

The necessary configuration for this is stored in the  ~/.grails/settings.groovy. Entries in this data are valid for all Grails projects and equivalent entries in the BuildConfig.groovy.

Here is an example of installing Archiva as release repository:
[groovy]
/*
* THIS IS FOR UPLOADING TO THE REPO (via release plugin)
* To use this do:
* grails2 install-plugin release
*/
grails.project.repos.default = “rrzeArchiva”

grails.project.repos.rrzeArchiva.url = “http://REPOSITORY:PORT/archiva/repository/internal/”
grails.project.repos.rrzeArchiva.username = “USERNAME”
grails.project.repos.rrzeArchiva.password = “PASSWORD”

// disable nagging about not having committed all changes…
grails.release.scm.enabled = false
[/groovy]

The example configures the rrzeArcchiva repository as Default for Uploads and deactivates the SVN proof for not-checked-in changes.

Done.

New releases can be loaded with the following Build Target in the Repository, respectively installed the local Maven Cache.
[bash]
grails maven-deploy
grails maven-install
[/bash]

Download

For the automatic download of plugins from the repository the following entries in the  BuildConfig.groovy of the project are needed.
[groovy]
grails.project.dependency.resolution = {
repositories {
mavenLocal()
mavenRepo name:”rrzeArchiva”, root:”http://REPOSITORY:PORT/archiva/repository/internal”
}
plugins {
runtime “:ppsa-menu:latest.release”
}
}
[/groovy]

The repository paragraph configures the local Maven Cache and the Archiva Repository as sources for plugin dependencies which have to be browsed.
The plugin dependencies themselves are managed in the own paragraph plugins. The example entry is always loading the most current version of the plugin ppsa-menu.

Actually this would be enough to install plugins on the repository.

Most of all intern repositories will though need further authentication. Therefore the following entry has to be added ~/.grails/settings.groovy.
[groovy]
/*
* THIS IS FOR DOWNLOADING FROM THE REPO
* To use this add this to your BuildConfig.groovy:
* mavenRepo name:”rrzeArchiva”, root:”http://REPOSITORY:PORT/archiva/repository/internal”
*/
grails.project.ivy.authentication = {
credentials {
realm = “Repository Archiva Managed internal Repository”
host = “REPOSITORY(ohne Port!)”
username = “USERNAME”
password = “PASSWORD”
}
}
[/groovy]

—- IMPORTANT —-

For Archiva the realm must be configured as shown. Or nothing will work!

Also, the Host must be stated here without Port. If the Archiva is also running e.g. on Port 8080 these information can be omitted here.
—- IMPORTANT —-