JeKa : le moyen le plus simple de publier sur Maven Central

JeKa est un outil de construction Java moderne axé sur la simplicité.
Cet article montre comment publier sur Maven Central avec une configuration minimale.

Prérequis : Vous avez besoin d'un compte OSSRH pour publier sur Maven Central.

Avec JeKa, vous pouvez configurer entièrement le build en éditant le fichier jeka.properties comme suit :

jeka.version=0.11.11
jeka.java.version=17

jeka.inject.classpath=dev.jeka:nexus-plugin
@nexus=

@project.moduleId=com.github.djeang:vincer-dom
@project.gitVersioning.enable=true

# Configuration for deploying to Maven central
@maven.publication.predefinedRepo=OSSRH
@maven.publication.metadata.projectName=Vincer-Dom
@maven.publication.metadata.projectDescription=Modern Dom manipulation library for Java
@maven.publication.metadata.projectUrl=https://github.com/djeang/vincer-dom
@maven.publication.metadata.projectScmUrl=https://github.com/djeang/vincer-dom.git
@maven.publication.metadata.licenses=Apache License V2.0:https://www.apache.org/licenses/LICENSE-2.0.html
@maven.publication.metadata.developers=djeang:djeangdev@yahoo.fr

Notez que les dépendances sont répertoriées dans un fichier dependencies.txt dédié afin de maintenir une séparation claire des préoccupations.

Pour publier sur Maven Central, exécutez : jeka project:pack maven:publish.

Voir un exemple concret ici.

Explications

Maintenant que vous savez comment faire, expliquons comment cela fonctionne.

Gestion des versions Jeka et Java

Pour une meilleure portabilité et reproductibilité, nous pouvons déclarer les versions Jeka et Java requises pour la construction. Les deux versions seront automatiquement téléchargées si elles ne sont pas déjà présentes sur la machine hôte.

Spécifier l'ID du module et la gestion des versions

Le moduleId publié est spécifié à l'aide de la propriété @project.moduleId.

La version peut être explicitement spécifiée à l'aide de la propriété @project.version. Notez que les propriétés peuvent être définies dans le fichier jeka.properties ou transmises comme argument de ligne de commande : -D@project.version=1.0.1.

Au lieu de cela, nous choisissons de nous appuyer sur Git pour déduire la version en utilisant : @project.gitVersioning.enable=true. S'il n'y a pas de balise sur le commit actuel, la version sera définie sur [branch]-SNAPSHOT; sinon, ce sera le nom-tag.

Configurer le référentiel de publications

@maven.publication.predefinedRepo=OSSRH demande à Jeka de publier dans le référentiel OSSRH prédéfini. Ce référentiel est configuré pour publier dans le référentiel d'instantanés OSSRH lorsque la version se termine par -SNAPSHOT, et dans le référentiel de version dans le cas contraire.

Le référentiel utilise les variables d'environnement suivantes pour transmettre les secrets :

• jeka.repos.publish.username : nom d'utilisateur du compte OSSRH
• jeka.repos.publish.password : mot de passe du compte OSSRH
• jeka.gpg.secret-key : Clé secrète blindée GPG sous forme de chaîne
• jeka.gpg.passphrase : La phrase secrète protégeant la clé secrète

Le contenu de jeka.gpg.secret-key peut être obtenu en exécutant : gpg --export-secret-key --armor my-key-name.

Fournir des métadonnées de publication

Les métadonnées obligatoires sont définies à l'aide des propriétés @maven.publication.metadata.xxx.

Notez que la propriété @maven.publication.metadata.licenses attend un format tel que : [license1 name]:[license1 url],[license2 name]:[license2 url],...

Publication automatique des versions

Pour plus de commodité, nous utilisons le plugin Nexus,

qui ferme automatiquement le référentiel intermédiaire sans nécessiter d'intervention manuelle.

jeka.inject.classpath=dev.jeka:nexus-plugin demande à Jeka de récupérer le plugin depuis Maven Central, tandis que @nexus= l'active.

Exécuter la construction

Pour publier, exécutez simplement : jeka project:pack maven:publish.

Ceci :

• Créez le JAR à publier (projet : pack).
• Créez des JAR source et Javadoc.
• Générez le fichier POM publié.
• Calculez toutes les sommes de contrôle.
• Signez tous les fichiers publiés.
• Poussez tout vers le référentiel OSSRH.

Pour voir ce qui sera publié, exécutez : jeka maven : info.

Réglage fin

Le réglage fin dans Jeka est généralement réalisé par programme, complétant la configuration déclarative du fichier jeka.properties. Cette approche permet des configurations très flexibles et puissantes avec les avantages du typage statique.

Personnaliser les dépendances transitives

Nous pouvons personnaliser les dépendances mentionnées dans le POM publié.

Dans l'exemple suivant, nous supprimons la dépendance com.google.guava:guava et forçons la dépendance jfiglet à avoir la portée RUNTIME.

jeka.version=0.11.11
jeka.java.version=17

jeka.inject.classpath=dev.jeka:nexus-plugin
@nexus=

@project.moduleId=com.github.djeang:vincer-dom
@project.gitVersioning.enable=true

# Configuration for deploying to Maven central
@maven.publication.predefinedRepo=OSSRH
@maven.publication.metadata.projectName=Vincer-Dom
@maven.publication.metadata.projectDescription=Modern Dom manipulation library for Java
@maven.publication.metadata.projectUrl=https://github.com/djeang/vincer-dom
@maven.publication.metadata.projectScmUrl=https://github.com/djeang/vincer-dom.git
@maven.publication.metadata.licenses=Apache License V2.0:https://www.apache.org/licenses/LICENSE-2.0.html
@maven.publication.metadata.developers=djeang:djeangdev@yahoo.fr

Ajouter des artefacts supplémentaires

L'API permet de définir des artefacts supplémentaires à publier.

Dans l'exemple suivant, deux artefacts sont générés au moment de la publication :

1. Un fichier ZIP contenant de la documentation.
2. Un uber JAR ombré (un JAR qui inclut toutes les classes des dépendances avec des packages renommés pour éviter les conflits).

class Build extends KBean {

    @Override
    void init() {
        var publication = load(MavenKBean.class).getMavenPublication();
        publication.customizeDependencies(deps -> deps
                .minus("com.google.guava:guava")
                .withTransitivity("com.github.lalyos:jfiglet", JkTransitivity.RUNTIME)
        );
    }

}

Publier sur d'autres référentiels

Pour publier sur un référentiel autre que Maven Central, vous pouvez définir les propriétés suivantes :

class Build extends KBean {

    @Override
    void init() {
        var publication = load(MavenKBean.class).getMavenPublication();
        publication.putArtifact(JkArtifactId.of("doc", "zip"), this::genDoc);
        publication.putArtifact(JkArtifactId.of("shade", "jar"), project.packaging::createShadeJar);
    }

    private void genDoc(Path targetZipFile) {
        // generate documentation and zip it in targetZipFile
    }

}

Placez ces propriétés dans [USER HOME]/.jeka/global.properties (au lieu du fichier jeka.properties) pour maintenir la cohérence des configurations entre les projets et éviter la redondance.

Pour plus de détails, reportez-vous à la documentation.

Comparaison avec Maven

Ce qui suit est l'équivalent de la configuration Maven POM pour déployer un projet sur Maven Central :

jeka.repos.publish=https://my.company/myrepo

# Optional properties
jeka.repos.publish.username=myUsername
jeka.repos.publish.password=myPassword
jeka.repos.publish.headers.Authorization=Bearer:: XHrU8hHKJHJ454==67g

Conclusion

Jeka fournit un moyen plus simple mais puissant de créer des logiciels Java et de publier des artefacts sur Maven Central ou d'autres référentiels, avec beaucoup moins de configuration et d'efforts que les outils traditionnels.

Visitez le site Web, les vidéos et les exemples pour avoir une idée de tout ce que Jeka peut faire de mieux.

Avertissement : Je suis l'auteur de Jeka.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!