JeKa: Der einfachste Weg, auf Maven Central zu veröffentlichen

JeKa ist ein modernes Java-Build-Tool, das auf Einfachheit ausgerichtet ist.
Dieser Beitrag zeigt, wie man mit minimaler Konfiguration in Maven Central veröffentlicht.

Voraussetzung:Sie benötigen ein OSSRH-Konto, um auf Maven Central zu veröffentlichen.

Mit JeKa können Sie den Build vollständig konfigurieren, indem Sie die Datei jeka.properties wie folgt bearbeiten:

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

Beachten Sie, dass Abhängigkeiten in einer speziellen dependencies.txt-Datei aufgeführt sind, um eine klare Trennung der Bedenken zu gewährleisten.

Um in Maven Central zu veröffentlichen, führen Sie Folgendes aus: jeka project:pack maven:publish.

Ein konkretes Beispiel finden Sie hier.

Erläuterungen

Da Sie nun wissen, wie es geht, erklären wir Ihnen, wie es funktioniert.

Jeka- und Java-Versionierung

Für eine bessere Portabilität und Reproduzierbarkeit können wir sowohl die Jeka- als auch die Java-Version deklarieren, die für die Erstellung erforderlich sind. Beide Versionen werden automatisch heruntergeladen, sofern sie nicht bereits auf dem Host-Computer vorhanden sind.

Geben Sie die Modul-ID und die Versionierung an

Die veröffentlichte Modul-ID wird mithilfe der Eigenschaft @project.moduleId angegeben.

Die Version kann explizit mit der Eigenschaft @project.version angegeben werden. Beachten Sie, dass Eigenschaften in der Datei jeka.properties festgelegt oder als Befehlszeilenargument übergeben werden können: -D@project.version=1.0.1.

Stattdessen verlassen wir uns darauf, dass Git die Version mithilfe von @project.gitVersioning.enable=true ableitet. Wenn beim aktuellen Commit kein Tag vorhanden ist, wird die Version auf [branch]-SNAPSHOT; andernfalls ist es der Tag-Name.

Konfigurieren Sie das Publikations-Repository

@maven.publication.predefinedRepo=OSSRH weist Jeka an, im vordefinierten OSSRH-Repository zu veröffentlichen. Dieses Repository ist so konfiguriert, dass es im OSSRH-Snapshot-Repository veröffentlicht, wenn die Version mit -SNAPSHOT endet, und andernfalls im Release-Repository.

Das Repository verwendet die folgenden Umgebungsvariablen, um Geheimnisse weiterzugeben:

• jeka.repos.publish.username: Benutzername des OSSRH-Kontos
• jeka.repos.publish.password: Passwort des OSSRH-Kontos
• jeka.gpg.secret-key: Gepanzerter geheimer GPG-Schlüssel als String
• jeka.gpg.passphrase: Die Passphrase, die den geheimen Schlüssel schützt

Der Inhalt von jeka.gpg.secret-key kann durch Ausführen von: gpg --export-secret-key --armor my-key-name.

abgerufen werden

Stellen Sie Publikationsmetadaten bereit

Die obligatorischen Metadaten werden mithilfe von @maven.publication.metadata.xxx-Eigenschaften festgelegt.

Beachten Sie, dass die Eigenschaft @maven.publication.metadata.licenses ein Format wie folgt erwartet: [Name der Lizenz1]:[URL der Lizenz1],[Name der Lizenz2]:[URL der Lizenz2],...

Automatisieren Sie die Veröffentlichung von Releases

Der Einfachheit halber verwenden wir das Nexus Plugin,

Dadurch wird das Staging-Repository automatisch geschlossen, ohne dass ein manueller Eingriff erforderlich ist.

jeka.inject.classpath=dev.jeka:nexus-plugin weist Jeka an, das Plugin von Maven Central abzurufen, während @nexus= es aktiviert.

Build ausführen

Zum Veröffentlichen führen Sie einfach Folgendes aus: jeka project:pack maven:publish.

Das wird:

• Erstellen Sie das zu veröffentlichende JAR (Projekt: Pack).
• Erstellen Sie Quell- und Javadoc-JARs.
• Generieren Sie die veröffentlichte POM-Datei.
• Berechnen Sie alle Prüfsummen.
• Signieren Sie alle veröffentlichten Dateien.
• Alles in das OSSRH-Repository verschieben.

Um zu sehen, was veröffentlicht wird, führen Sie Folgendes aus: jeka maven: info.

Feinabstimmung

Die Feinabstimmung in Jeka erfolgt im Allgemeinen programmgesteuert und ergänzt die deklarative Konfiguration aus der Datei jeka.properties. Dieser Ansatz ermöglicht äußerst flexible und leistungsstarke Konfigurationen mit den Vorteilen der statischen Typisierung.

Passen Sie transitive Abhängigkeiten an

Wir können die im veröffentlichten POM erwähnten Abhängigkeiten anpassen.

Im folgenden Beispiel entfernen wir die Abhängigkeit com.google.guava:guava und erzwingen, dass die Abhängigkeit jfiglet den RUNTIME-Bereich hat.

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

Fügen Sie zusätzliche Artefakte hinzu

Die API ermöglicht die Definition zusätzlicher zu veröffentlichender Artefakte.

Im folgenden Beispiel werden zum Zeitpunkt der Veröffentlichung zwei Artefakte generiert:

1. Eine ZIP-Datei mit Dokumentation.
2. Eine schattierte Uber-JAR (eine JAR, die alle Klassen aus Abhängigkeiten mit umbenannten Paketen enthält, um Konflikte zu vermeiden).

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)
        );
    }

}

Auf anderen Repositories veröffentlichen

Um in einem anderen Repository als Maven Central zu veröffentlichen, können Sie die folgenden Eigenschaften festlegen:

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
    }

}

Platzieren Sie diese Eigenschaften in [USER HOME]/.jeka/global.properties (anstelle der Datei jeka.properties), um Konfigurationen projektübergreifend konsistent zu halten und Redundanz zu vermeiden.

Weitere Einzelheiten finden Sie in der Dokumentation.

Vergleich mit Maven

Das Folgende ist das Maven-POM-Konfigurationsäquivalent für die Bereitstellung eines Projekts in 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

Abschluss

Jeka bietet eine einfachere und dennoch leistungsstarke Möglichkeit, Java-Software zu erstellen und Artefakte in Maven Central oder anderen Repositorys zu veröffentlichen, mit viel weniger Konfiguration und Aufwand als herkömmliche Tools.

Besuchen Sie die Website, Videos und Beispiele, um eine Vorstellung davon zu bekommen, was Jeka noch besser machen kann.

Haftungsausschluss:Ich bin der Autor von Jeka.

Das obige ist der detaillierte Inhalt vonJeKa: Der einfachste Weg, auf Maven Central zu veröffentlichen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!