Postavka GitLab CI za objavljivanje java projekta na Maven Central

Ovaj članak je namijenjen Java programerima koji trebaju brzo objaviti svoje proizvode u Sonatype i/ili Maven Central repozitorijima koristeći GitLab. U ovom članku ću objasniti postavke gitlab-runner, gitlab-ci i maven-plugin za rješavanje ovog zadatka.

Preduvjeti:

  • Sigurno pohranjivanje mvn i GPG ključeva.
  • Sigurno izvođenje javnih CI zadataka.
  • Učitavanje artefakata (release/snapshot) u javne repozitorije.
  • Automatska provjera release verzija za objavu u Maven Central.
  • Opće rješenje za učitavanje artefakata u repozitorij za više projekata.
  • Jednostavnost i praktičnost upotrebe.

Sadržaj

Opće informacije

  • Detaljan opis mehanizma objavljivanja artefakata u Maven Central putem Sonatype OSS Repository Hosting Service već je opisan u ovom članku korisnikom Googolplex, stoga ću se u potrebnim mjestima pozivati na ovaj članak.
  • Prvo se registrirajte na Sonatype JIRA i otvorite tiketa za kreiranje repozitorija (više informacija u odjeljku Otvorite tiket na Sonatype JIRA). Nakon otvaranja repozitorija, par korisničkog imena/lozinke s JIRA (dalje Sonatype račun) bit će korišten za učitavanje artefakata u Sonatype nexus.
  • Dalje, postupak generiranja GPG ključa opisuje se prilično suho. Za više informacija pogledajte odjeljak Postavljanje GnuPG za potpisivanje artefakata
  • Ako koristite Linux konzolu za generiranje GPG ključa (gnupg/gnupg2), potrebno je instalirati rng-tools za generiranje entropije. Inače, generiranje ključa može potrajati dugo.
  • Usvojene usluge javnih GPG ključeva

Na sadržaj

Postavljanje deploy projekta u GitLab

  • Prvo je potrebno stvoriti i postaviti projekt u kojem će se pohranjivati pipeline za deploy artefakata. Moj projekt sam jednostavno nazvao — deploy
  • Nakon stvaranja repozitorija, potrebno je ograničiti pristup izmjenama repozitorija.
    Idemo u projekt -> Postavke -> Repozitorij -> Zaštićene grane. Brišemo sve pravila i dodajemo jedno jedino pravilo s Wildcard * s pravima na push i merge samo za korisnike s ulogom Maintainers. Ovo pravilo će raditi za sve korisnike ovog projekta, kao i za grupu u koju ovaj projekt spada.
    Postavka GitLab CI za objavljivanje java projekta na Maven Central
  • Ako je više mainternera, najbolja opcija je ograničiti pristup projektu uopće.
    Idemo u projekt -> Postavke -> Općenito -> Vidljivost, mogućnosti projekta, dopuštenja i postavljamo vidljivost projekta na Privatno.
    Moj projekt je javno dostupan, jer koristim vlastiti GitLab Runner i promjene repozitorija mogu raditi samo ja. Također, nije u mom interesu otkrivati privatne informacije u javnim logovima pipeline-a.
  • Pojačavanje pravila za promjene repozitorija
    Idemo u projekt -> Postavke -> Repozitorij -> Pravila push-a i postavljamo oznake Ograničenje commitera, Provjeriti je li autor GitLab korisnik. Također preporučam konfigurirati potpisivanje commit-a, i postaviti oznaku Odbij nepotpisane commit-e.
  • Sljedeće treba konfigurirati okidač za pokretanje zadataka
    Idemo u projekt -> Postavke -> CI/CD -> Okidači pipeline-a i kreiramo novi trigger-token
    Ovaj token možete odmah dodati u opću konfiguraciju varijabli za grupu projekata.
    Idemo u grupu -> Postavke -> CI/CD -> Varijable i dodajemo varijablu DEPLOY_TOKEN s trigger-token u vrijednosti.

Na sadržaj

GitLab Runnere

Ovaj dio opisuje konfiguraciju za pokretanje zadataka na deploy koristeći vlastite (Specifične) i javne (Dijeljene) ranere.

Specifični Runner

Koristim vlastite ranere, jer je to prije svega praktično, brzo i jeftino.
Za raner preporučam Linux VDS s 1 CPU, 2 GB RAM, 20 GB HDD. Cijena je ~3000₽ godišnje.

Moj raner

Za raner nabavio sam VDS s 4 CPU, 4 GB RAM, 50 GB SSD. Koštalo je ~11000₽ i nikada nisam zažalio.
Imam ukupno 7 mašina. 5 na arubi i 2 na ihoru.

Dakle, imamo raner. Sada ćemo ga konfigurirati.
Prijaviti se na mašinu putem SSH i instalirati java, git, maven, gnupg2.

Na sadržaj

Instaliramo gitlab runner

  • Kreiramo novu grupu pokretač
    sudo groupadd runner
  • Kreiramo direktorij za maven cache i dodjeljujemo grupna prava pokretač
    Ovu točku možete preskočiti ako ne planirate pokretati više ranera na istoj mašini.
    mkdir -p /usr/cache/.m2/repository
    chown -R :runner /usr/cache
    chmod -R 770 /usr/cache
  • Kreiramo korisnika gitlab-deployer i dodajemo u grupu pokretač
    useradd -m -d /home/gitlab-deployer gitlab-deployer
    usermod -a -G runner gitlab-deployer
  • Dodajemo u datoteku /etc/ssh/sshd_config sljedeći redak
    AllowUsers root@* gitlab-deployer@127.0.0.1
  • Ponovo pokrećemo sshd
    systemctl restart sshd
  • Postavljamo lozinku za korisnika gitlab-deployer (može biti jednostavna, budući da važi ograničenje za localhost)
    passwd gitlab-deployer
  • Instaliramo GitLab Runner (Linux x86-64)
    sudo wget -O /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-amd64
    sudo chmod +x /usr/local/bin/gitlab-runner
    ln -s /usr/local/bin/gitlab-runner /etc/alternatives/gitlab-runner
    ln -s /etc/alternatives/gitlab-runner /usr/bin/gitlab-runner
  • Idemo na stranicu gitlab.com -> deploy-project -> Settings -> CI/CD -> Runners -> Specific Runners i kopiramo registration token

Snimka ekrana

Postavka GitLab CI za objavljivanje java projekta na Maven Central

  • Registriramo runner
    gitlab-runner register --config /etc/gitlab-runner/gitlab-deployer-config.toml

Proces

Runtime platform arch=amd64 os=linux pid=17594 revision=3001a600 version=11.10.0
Running in system-mode.
Molimo unesite gitlab-ci koordinator URL (npr. https://gitlab.com/):
https://gitlab.com/
Molimo unesite gitlab-ci token za ovog runnera:
REGISTRATION_TOKEN
Molimo unesite gitlab-ci opis za ovog runnera:
[ih1174328.vds.myihor.ru]: Deploy Runner
Molimo unesite gitlab-ci oznake za ovog runnera (odvojene zarezom):
deploy
Registracija runnera... uspjela                     runner=ZvKdjJhx
Molimo unesite izvršitelja: docker-ssh, parallels, virtualbox, docker-ssh+machine, kubernetes, docker, ssh, docker+machine, shell:
shell
Runner uspješno registriran. Slobodno ga pokrenite, ali ako već radi, konfiguracija bi trebala biti automatski učitana!
  • Provjeravamo je li runner registriran. Idemo na stranicu gitlab.com -> deploy-project -> Settings -> CI/CD -> Runners -> Specific Runners -> Runners activated for this project

Snimka ekrana

Postavka GitLab CI za objavljivanje java projekta na Maven Central

  • Dodajemo odvojen usluga /etc/systemd/system/gitlab-deployer.service
    [Unit]
    Description=GitLab Deploy Runner
    After=syslog.target network.target
    ConditionFileIsExecutable=/usr/local/bin/gitlab-runner
    [Service]
    StartLimitInterval=5
    StartLimitBurst=10
    ExecStart=/usr/local/bin/gitlab-runner "run" "--working-directory" "/home/gitlab-deployer" "--config" "/etc/gitlab-runner/gitlab-deployer-config.toml" "--service" "gitlab-deployer" "--syslog" "--user" "gitlab-deployer"
    Restart=always
    RestartSec=120
    [Install]
    WantedBy=multi-user.target
  • Pokrećemo servis.
    systemctl enable gitlab-deployer.service
    systemctl start gitlab-deployer.service
    systemctl status gitlab-deployer.service
  • Provjeravamo je li runner pokrenut.

Primjer

Postavka GitLab CI za objavljivanje java projekta na Maven Central

Na sadržaj

Generiranje GPG ključeva

  • S ove mašine ulazimo preko ssh pod korisničkim gitlab-deployer (to je važno za generiranje GPG ključa)
    ssh gitlab-deployer@127.0.0.1
  • Generiramo ključ odgovarajući na pitanja. Koristio sam svoje ime i e-mail.
    Obavezno navedite lozinku za ključ. Ovaj ključ će se koristiti za potpisivanje artefakata.
    gpg --gen-key 
  • Provjeravamo
    gpg --list-keys -a
    /home/gitlab-deployer/.gnupg/pubring.gpg
    ----------------------------------------
    pub   4096R/00000000 2019-04-19
    uid                  Petruha Petrov 
    sub   4096R/11111111 2019-04-19
  • Otpremamo naš javni ključ na server ključeva
    gpg --keyserver keys.gnupg.net --send-key 00000000
    gpg: slanje ključa 00000000 na hkp server keys.gnupg.net

Na sadržaj

Postavka Mavena

  • Ulazimo pod korisnikom gitlab-deployer
    su gitlab-deployer 
  • Kreiramo direktorij maven repository i povezujemo s kešom (ne pogriješite)
    Ovu stavku možete preskočiti ako ne planirate pokretati više runnera na jednoj mašini.
    mkdir -p ~/.m2/repository
    ln -s /usr/cache/.m2/repository /home/gitlab-deployer/.m2/repository
  • Kreiramo master ključ
    mvn --encrypt-master-password password
    {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}
  • Kreiramo datoteku ~/.m2/settings-security.xml
    {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}
  • Šifriramo lozinku za Sonatype račun
    mvn --encrypt-password SONATYPE_PASSWORD
    {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J}
  • Stvaramo datoteku ~/ .m2 / settings.xml
    env
            
                true
            
            
                GPG_SECRET_KEY_PASSPHRASE
            
        
    
    
        
            sonatype
            SONATYPE_USERNAME
            {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J}

gde,
GPG_SECRET_KEY_PASSPHRASE — lozinka za GPG ključ
SONATYPE_USERNAME — korisničko ime za Sonatype račun

Ovdje je postavka ranjera završena, možemo preći na odjeljak GitLab CI

Na sadržaj

Shared Runner

Generiranje GPG ključeva

  • Prvo je potrebno stvoriti GPG ključ. Za to instaliramo gnupg.
    yum install -y gnupg
  • Generiramo ključ odgovarajući na pitanja. Koristio sam svoje ime i e-mail. Obavezno navedite lozinku za ključ.
    gpg --gen-key 
  • Prikazujemo informacije o ključu
    gpg --list-keys -a
    pub   rsa3072 2019-04-24 [SC] [expires: 2021-04-23]
      2D0D1706366FC4AEF79669E24D09C55BBA3FD728
    uid           [ultimate] tttemp 
    sub   rsa3072 2019-04-24 [E] [expires: none]
  • Otpremamo naš javni ključ na server ključeva
    gpg --keyserver keys.gnupg.net --send-key 2D0D1706366FC4AEF79669E24D09C55BBA3FD728
    gpg: slanje ključa 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 na hkp poslužitelj keys.gnupg.net
  • Dobivamo privatni ključ
    gpg --export-secret-keys --armor 2D0D1706366FC4AEF79669E24D09C55BBA3FD728
    -----BEGIN PGP PRIVATE KEY BLOCK-----
    lQWGBFzAqp8BDADN41CPwJ/gQwiKEbyA902DKw/WSB1AvZQvV/ZFV77xGeG4K7k5
    ...
    =2Wd2
    -----END PGP PRIVATE KEY BLOCK-----
  • Idemo na postavke projekta -> Postavke -> CI / CD -> Varijable i spremamo privatni ključ u varijablu GPG_SECRET_KEY
    Postavka GitLab CI za objavljivanje java projekta na Maven Central

Na sadržaj

Postavka Mavena

  • Kreiramo master ključ
    mvn --encrypt-master-password password
    {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}
  • Idemo na postavke projekta -> Postavke -> CI / CD -> Varijable i spremamo u varijablu SETTINGS_SECURITY_XML sljedeće retke:
    {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}
  • Šifriramo lozinku za Sonatype račun
    mvn --encrypt-password SONATYPE_PASSWORD
    {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J}
  • Idemo na postavke projekta -> Postavke -> CI / CD -> Varijable i spremamo u varijablu SETTINGS_XML sljedeće retke:
    env
            
                true
            
            
                GPG_SECRET_KEY_PASSPHRASE
            
        
    
    
        
            sonatype
            sonatype_username
            {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J}

gde,
GPG_SECRET_KEY_PASSPHRASE — lozinka za GPG ključ
SONATYPE_USERNAME — korisničko ime za Sonatype račun

Na sadržaj

Deploy docker slike

  • Stvaramo dovoljno jednostavan Dockerfile za pokretanje zadataka na deploy s potrebnom verzijom Jave. U nastavku je primjer za alpine.
    FROM java:8u111-jdk-alpine
    RUN apk add gnupg maven git --update-cache 
    --repository http://dl-4.alpinelinux.org/alpine/edge/community/ --allow-untrusted && 
    mkdir ~/ .m2 /
  • Gradimo kontejner za vaš projekt
    docker build -t registry.gitlab.com/group/deploy .
  • Autentificiramo se i učitavamo kontejner u registry.
    docker login -u USER -p PASSWORD registry.gitlab.com
    docker push registry.gitlab.com/group/deploy

Na sadržaj

GitLab CI

Deploy projekta

Dodajte datoteku .gitlab-ci.yml u korijenu deploy projekta
Skripta prikazuje dva međusobno isključiva zadatka za deploy. Specifični Runner ili Dijeljeni Runner.

.gitlab-ci.yml

stages:
  - deploy

Specifični Runner:
  extends: .java_deploy_template
  # Zadatak će se izvršavati na vašem shell runneru
  tags:
    - deploy

Dijeljeni Runner:
  extends: .java_deploy_template
  # Zadatak će se izvršavati na javnom docker runneru
  tags:
    - docker
  # Slika iz odjeljka GitLab Runner -> Dijeljeni Runner -> Docker
  image: registry.gitlab.com/group/deploy-project:latest
  before_script:
    # Uvozimo GPG ključ
    - printf "${GPG_SECRET_KEY}" | gpg --batch --import
    # Spremamo maven konfiguraciju
    - printf "${SETTINGS_SECURITY_XML}" > ~/.",m2/settings-security.xml
    - printf "${SETTINGS_XML}" > ~/.",m2/settings.xml

.java_deploy_template:
  stage: deploy
  # Zadatak će se aktivirati putem trigeriranja ako je proslijeđena varijabla DEPLOY s vrijednošću java
  only:
    variables:
    - $DEPLOY == "java"
  variables:
    # onemogućavamo kloniranje trenutnog projekta
    GIT_STRATEGY: none
  script:
    # Omogućujemo pohranu lozinke u nešifriranom obliku
    - git config --global credential.helper store
    # Spremamo privremene kredencijale korisnika gitlab-ci-token
    # Token radi za sve javne projekte gitlab.com i za projekte grupe
    - echo "https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com" >> ~/.",git-credentials
    # Potpuno čistimo trenutni direktorij
    - rm -rf .* *
    # Kloniramo projekt koji ćemo deployati u Sonatype Nexus
    - git clone ${DEPLOY_CI_REPOSITORY_URL} .
    # Prebacujemo se na potrebni commit
    - git checkout ${DEPLOY_CI_COMMIT_SHA} -f
    # Ako bilo koji pom.xml sadrži parametar autoReleaseAfterClose, failamo build.
    # U suprotnom postoji rizik od slanja sirovih artefakata u maven central
    - >
      for pom in $(find . -name pom.xml); do
        if [[ $(grep -q autoReleaseAfterClose "$pom" && echo $?) == 0 ]]; then
          echo "Datoteka $pom sadrži zabranjeno podešavanje: ";
          exit 1;
        fi;
      done
    # Ako je parametar DEPLOY_CI_COMMIT_TAG prazan, tada prisilno postavljamo SNAPSHOT verziju
    - >
      if [[ "${DEPLOY_CI_COMMIT_TAG}" != "" ]]; then
        mvn versions:set -DnewVersion=${DEPLOY_CI_COMMIT_TAG}
      else
        VERSION=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)
        if [[ "${VERSION}" == *-SNAPSHOT ]]; then
          mvn versions:set -DnewVersion=${VERSION}
        else
          mvn versions:set -DnewVersion=${VERSION}-SNAPSHOT
        fi
      fi
    # Pokrećemo zadatak za build i deploy artefakata
    - mvn clean deploy -DskipTests=true

Na sadržaj

Java projekt

U java projektima koji se planiraju učitati u javne repozitorije potrebno je dodati 2 koraka za učitavanje Release i Snapshot verzija.

.gitlab-ci.yml

stages:
  - build
  - test
  - verify
  - deploy



Release:
  extends: .trigger_deploy
  # Izvodi zadatak samo po oznaci.
  only:
    - tags

Snapshot:
  extends: .trigger_deploy
  # Izvodimo zadatak za objavu SNAPSHOT verzije ručno
  when: manual
  # Ne pokrećite zadatak ako je dodana oznaka.
  except:
    - tags

.trigger_deploy:
  stage: deploy
  variables:
    # Isključujemo kloniranje trenutnog projekta
    GIT_STRATEGY: none
    # Link na trigger deploy-zadatka
    URL: "https://gitlab.com/api/v4/projects//trigger/pipeline"
    # Varijable za deploy-zadatak
    POST_DATA: "
      token=${DEPLOY_TOKEN}&
      ref=master&
      variables[DEPLOY]=${DEPLOY}&
      variables[DEPLOY_CI_REPOSITORY_URL]=${CI_REPOSITORY_URL}&
      variables[DEPLOY_CI_PROJECT_NAME]=${CI_PROJECT_NAME}&
      variables[DEPLOY_CI_COMMIT_SHA]=${CI_COMMIT_SHA}&
      variables[DEPLOY_CI_COMMIT_TAG]=${CI_COMMIT_TAG}
      "
  script:
    # Ne koristim cURL, jer s opcijama --fail --show-error
    # ne prikazuje telo odgovora ako je HTTP kod 400 i više
    - wget --content-on-error -qO- ${URL} --post-data ${POST_DATA}

U ovom rešenju otišao sam korak dalje i odlučio da koristim jedan CI šablon za java projekte.

Detaljnije

Napravio sam poseban projekat gitlab-ci u kojem sam postavio CI šablon za java projekte common.yml.

common.yml

stages:
  - build
  - test
  - verify
  - deploy

variables:
  SONAR_ARGS: "
  -Dsonar.gitlab.commit_sha=${CI_COMMIT_SHA} 
  -Dsonar.gitlab.ref_name=${CI_COMMIT_REF_NAME} 
  "

.build_java_project:
  stage: build
  tags:
    - touchbit-shell
  variables:
    SKIP_TEST: "false"
  script:
    - mvn clean
    - mvn package -DskipTests=${SKIP_TEST}
  artifacts:
    when: always
    expire_in: 30 day
    paths:
      - "*\/target\/reports"

.build_sphinx_doc:
  stage: build
  tags:
    - touchbit-shell
  variables:
    DOCKERFILE: .indirect\/docs\/Dockerfile
  script:
    - docker build --no-cache -t ${CI_PROJECT_NAME}\/doc -f ${DOCKERFILE} .

.junit_module_test_run:
  stage: test
  tags:
    - touchbit-shell
  variables:
    MODULE: ""
  script:
    - cd ${MODULE}
    - mvn test
  artifacts:
    when: always
    expire_in: 30 day
    paths:
      - "*\/target\/reports"

.junit_test_run:
  stage: test
  tags:
    - touchbit-shell
  script:
    - mvn test
  artifacts:
    when: always
    expire_in: 30 day
    paths:
    - "*\/target\/reports"

.sonar_review:
  stage: verify
  tags:
    - touchbit-shell
  dependencies: []
  script:
    - >
      if [ "$CI_BUILD_REF_NAME" == "master" ]; then
        mvn compile sonar:sonar -Dsonar.login=$SONAR_LOGIN $SONAR_ARGS
      else
        mvn compile sonar:sonar -Dsonar.login=$SONAR_LOGIN $SONAR_ARGS -Dsonar.analysis.mode=preview
      fi

.trigger_deploy:
  stage: deploy
  tags:
    - touchbit-shell
  variables:
    URL: "https://gitlab.com/api/v4/projects/10345765/trigger/pipeline"
    POST_DATA: "
      token=${DEPLOY_TOKEN}&
      ref=master&
      variables[DEPLOY]=${DEPLOY}&
      variables[DEPLOY_CI_REPOSITORY_URL]=${CI_REPOSITORY_URL}&
      variables[DEPLOY_CI_PROJECT_NAME]=${CI_PROJECT_NAME}&
      variables[DEPLOY_CI_COMMIT_SHA]=${CI_COMMIT_SHA}&
      variables[DEPLOY_CI_COMMIT_TAG]=${CI_COMMIT_TAG}
      "
  script:
  - wget --content-on-error -qO- ${URL} --post-data ${POST_DATA}

.trigger_release_deploy:
  extends: .trigger_deploy
  only:
    - tags

.trigger_snapshot_deploy:
  extends: .trigger_deploy
  when: manual
  except:
    - tags

Kao rezultat, .gitlab-ci.yml u samim java projektima izgleda vrlo kompaktno i nije previše raspršeno.

.gitlab-ci.yml

include: https://gitlab.com/TouchBIT/gitlab-ci/raw/master/common.yml

Shields4J:
  extends: .build_java_project

Sphinx doc:
  extends: .build_sphinx_doc
  variables:
    DOCKERFILE: .docs/Dockerfile

Sonar review:
  extends: .sonar_review
  dependencies:
    - Shields4J

Release:
  extends: .trigger_release_deploy

Snapshot:
  extends: .trigger_snapshot_deploy

Na sadržaj

Konfiguracija pom.xml

Ova tema je vrlo detaljno opisna. Googolplex u Postavljanje Mavena za automatsko potpisivanje i učitavanje artefakata u snapshot i staging repozitorije., stoga ću opisati neke nijanse korištenja plugina. Također, opisat ću kako se lako i bez napora može koristiti nexus-staging-maven-plugin, ako ne želite ili ne možete koristiti org.sonatype.oss:oss-parent kao roditelj za svoj projekt.

maven-install-plugin

Instalira module u lokalni repozitorij.
Izuzetno koristan za lokalno provjeravanje rješenja u drugim projektima, kao i za kontrolnu sumu.

org.apache.maven.plugins
  maven-install-plugin
  
    
      install-project
      
      install
      
      
        target/${project.artifactId}-${project.version}.jar
        target/${project.artifactId}-${project.version}-sources.jar
        dependency-reduced-pom.xml
        
        true
        
        true

Na sadržaj

maven-javadoc-plugin

Generiranje javadoc za projekt.

org.apache.maven.plugins
  maven-javadoc-plugin
  
    
      
        jar
      
      
      prepare-package
      
        
        true
        true
        
        false

Ako imate modul koji ne sadrži java (na primjer samo resurse)
Ili ne želite u principu generirati javadoc, onda je ovdje pomoć maven-jar-plugin

org.apache.maven.plugins
  maven-jar-plugin
  
    
      empty-javadoc-jar
      generate-resources
      
        jar
      
      
        javadoc
        ${basedir}/javadoc

Na sadržaj

maven-gpg-plugin

org.apache.maven.plugins
  maven-gpg-plugin
  
    
      sign-artifacts
      deploy
      
        sign

Na sadržaj

nexus-staging-maven-plugin

Konfiguracija:

org.sonatype.plugins
        nexus-staging-maven-plugin
      
    
    
      
        
          org.sonatype.plugins
          nexus-staging-maven-plugin
          true
          
            sonatype
            https://oss.sonatype.org/
            true
          
        
        
          org.apache.maven.plugins
          maven-deploy-plugin
          
            true
          
        
      
    
  
  
    
      sonatype
      Nexus Snapshot Repository
      https://oss.sonatype.org/content/repositories/snapshots/
    
    
      sonatype
      Nexus Release Repository
      https://oss.sonatype.org/service/local/staging/deploy/maven2/

Ako imate višemodularni projekt i ne trebate određeni modul učitati u repozitorij, potrebno je dodati nexus-staging-maven-plugin s oznakom skipNexusStagingDeployMojo

org.sonatype.plugins
      nexus-staging-maven-plugin
      
        true

Nakon učitavanja, snapshot/release verzije dostupne su u staging repozitoriji

SonatypeNexus
    https://oss.sonatype.org/content/groups/staging/
    

Još prednosti

  • Vrlo bogat popis ciljeva za rad s nexus repozitorijem (mvn help:describe -Dplugin=org.sonatype.plugins:nexus-staging-maven-plugin).
  • Automatska provjera izdanja za mogućnost učitavanja u maven central

Na sadržaj

Rezultat

Objavljivanje SNAPSHOT verzije

Prilikom izrade projekta postoji mogućnost ručnog pokretanja zadatka za učitavanje SNAPSHOT verzije u nexus

Postavka GitLab CI za objavljivanje java projekta na Maven Central

Prilikom pokretanja ovog zadatka aktivira se odgovarajući zadatak u projektu deploy (primjer).

Iseceni log

Pokretanje s gitlab-runner 11.10.0 (3001a600)
  na Deploy runner JSKWyxUw
Koristeći Shell executor...
Izvršavanje na ih1174328.vds.myihor.ru...
Preskočeno podešavanje Git repozitorija
Preskočeno Git checkout
Preskočeno podešavanje Git podmodula
$ rm -rf .* *
$ git config --global credential.helper store
$ echo "https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com" >> ~/ .git-credentials
$ git clone ${DEPLOY_CI_REPOSITORY_URL} .
Klona u 'shields4j'...
$ git checkout ${DEPLOY_CI_COMMIT_SHA}
Napomena: provjera '850f86aa317194395c5387790da1350e437125a7'.
Nalazite se u 'odvojenom HEAD' stanju. Možete istraživati, napraviti eksperimentalne
promjene i potvrditi ih, a možete odbaciti bilo koje potvrde koje napravite u ovom
stanju bez utjecaja na bilo koje grane vršenjem drugog checkout-a.
Ako želite stvoriti novu granu da zadržite potvrde koje kreirate, možete
to učiniti (sada ili kasnije) koristeći -b s naredbom checkout ponovno. Primjer:
  git checkout -b new_branch_name
HEAD je sada na 850f86a... preskoči deploy test-core
$ for pom in $(find . -name pom.xml); do # skraćena višelinijska naredba
$ if [[ "${DEPLOY_CI_COMMIT_TAG}" != "" ]]; then # skraćena višelinijska naredba
[INFO] Skener za projekte...
[INFO] Provjera gradnje s ukupno 4 modula...
[INFO] Instalacija funkcija Nexus Staging:
[INFO]   ... ukupno 4 izvršenja maven-deploy-plugin zamijenjena s nexus-staging-maven-plugin
[INFO] ------------------------------------------------------------------------
[INFO] Redoslijed izgradnje Reactora:
[INFO] 
[INFO] Shields4J                                                          [pom]
[INFO] test-core                                                          [jar]
[INFO] Shields4J klijent                                                   [jar]
[INFO] TestNG slušatelj                                                    [jar]
[INFO] 
[INFO] -----------------------------
[INFO] Gradnja Shields4J 1.0.0                                           [1/4]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO] 
[INFO] --- versions-maven-plugin:2.5:set (default-cli) @ shields4j-parent ---
[INFO] Traženje lokalnog korijena agregatora...
[INFO] Lokalni korijen agregacije: /home/gitlab-deployer/JSKWyxUw/0/TouchBIT/deploy/shields4j
[INFO] Obrada promjene org.touchbit.shields4j:shields4j-parent:1.0.0 -> 1.0.0-SNAPSHOT
[INFO] Obrada org.touchbit.shields4j:shields4j-parent
[INFO]     Ažuriranje projekta org.touchbit.shields4j:shields4j-parent
[INFO]         iz verzije 1.0.0 na 1.0.0-SNAPSHOT
[INFO] 
[INFO] Obrada org.touchbit.shields4j:client
[INFO]     Ažuriranje roditelja org.touchbit.shields4j:shields4j-parent
[INFO]         iz verzije 1.0.0 na 1.0.0-SNAPSHOT
[INFO]     Ažuriranje ovisnosti org.touchbit.shields4j:test-core
[INFO]         iz verzije 1.0.0 na 1.0.0-SNAPSHOT
[INFO] 
[INFO] Obrada org.touchbit.shields4j:test-core
[INFO]     Ažuriranje roditelja org.touchbit.shields4j:shields4j-parent
[INFO]         iz verzije 1.0.0 na 1.0.0-SNAPSHOT
[INFO] 
[INFO] Obrada org.touchbit.shields4j:testng
[INFO]     Ažuriranje roditelja org.touchbit.shields4j:shields4j-parent
[INFO]         iz verzije 1.0.0 na 1.0.0-SNAPSHOT
[INFO]     Ažuriranje ovisnosti org.touchbit.shields4j:client
[INFO]         iz verzije 1.0.0 na 1.0.0-SNAPSHOT
[INFO]     Ažuriranje ovisnosti org.touchbit.shields4j:test-core
[INFO]         iz verzije 1.0.0 na 1.0.0-SNAPSHOT
[INFO] 
[INFO] ------------------------------------------------------------------------
[INFO] Sažetak Reactora:
[INFO] 
[INFO] Shields4J 1.0.0 .................................... USPJEH [  0.992 s]
[INFO] test-core .......................................... PRESKOČENO
[INFO] Shields4J klijent ................................... PRESKOČENO
[INFO] TestNG slušatelj 1.0.0 .............................. PRESKOČENO
[INFO] ------------------------------------------------------------------------
[INFO] IZGRADNJA USPJEHA
[INFO] ------------------------------------------------------------------------
[INFO] Ukupno vrijeme: 2.483 s
[INFO] Završeno u: 2019-04-21T02:40:42+03:00
[INFO] ------------------------------------------------------------------------
$ mvn clean deploy -DskipTests=${SKIP_TESTS}
[INFO] Skener za projekte...
[INFO] Provjera gradnje s ukupno 4 modula...
[INFO] Instalacija funkcija Nexus Staging:
[INFO]   ... ukupno 4 izvršenja maven-deploy-plugin zamijenjena s nexus-staging-maven-plugin
[INFO] ------------------------------------------------------------------------
[INFO] Redoslijed izgradnje Reactora:
[INFO] 
[INFO] Shields4J                                                          [pom]
[INFO] test-core                                                          [jar]
[INFO] Shields4J klijent                                                   [jar]
[INFO] TestNG slušatelj                                                    [jar]
[INFO] 
[INFO] -----------------------------
[INFO] Gradnja Shields4J 1.0.0-SNAPSHOT                                  [1/4]
[INFO] --------------------------------[ pom ]---------------------------------
...
DELETIRANO
...
[INFO]  * Veliko izvođenje lokalno prikupljenih snimaka artefakata završeno.
[INFO] Udaljeno izvođenje završeno s uspjehom.
[INFO] ------------------------------------------------------------------------
[INFO] Sažetak Reactora:
[INFO] 
[INFO] Shields4J 1.0.0-SNAPSHOT ........................... USPJEH [  2.375 s]
[INFO] test-core .......................................... USPJEH [  3.929 s]
[INFO] Shields4J klijent ................................... USPJEH [  3.815 s]
[INFO] TestNG slušatelj 1.0.0-SNAPSHOT ..................... USPJEH [ 36.134 s]
[INFO] ------------------------------------------------------------------------
[INFO] IZGRADNJA USPJEHA
[INFO] ------------------------------------------------------------------------
[INFO] Ukupno vrijeme: 47.629 s
[INFO] Završeno u: 2019-04-21T02:41:32+03:00
[INFO] ------------------------------------------------------------------------

Kao rezultat, u nexus je učitana verzija 1.0.0-SNAPSHOT.

Sve snapshot verzije mogu se izbrisati iz repozitorija na webu oss.sonatype.org pod svojim korisničkim računom.

Postavka GitLab CI za objavljivanje java projekta na Maven Central

Na sadržaj

Objavljivanje release verzije

Prilikom postavljanja taga automatski se pokreće odgovarajući zadatak u projektu deploy za učitavanje release verzije u nexus (primjer).

Postavka GitLab CI za objavljivanje java projekta na Maven Central

Najugodnije je to što se automatski zatvara release u nexus.

[INFO] Izvršavanje daljinskog stanjivanja...
[INFO] 
[INFO]  * Daljinsko stanjivanje u profil stanjivanja ID "9043b43f77dcc9"
[INFO]  * Stvoren profil sa stanjivanjem s ID "orgtouchbit-1037".
[INFO]  * Stanjivanje repozitorija na https://oss.sonatype.org:443/service/local/staging/deployByRepositoryId/orgtouchbit-1037
[INFO]  * Učitavanje lokalno stanjivanih artefakata u profil org.touchbit
[INFO]  * Učitavanje lokalno stanjivanih artefakata završeno.
[INFO]  * Zatvaranje repozitorija s stanjivanjem ID "orgtouchbit-1037".
Čekanje na završetak operacije...
.........
[INFO] Daljinski stanjivano 1 repozitorija, završeno s uspjehom.
[INFO] ------------------------------------------------------------------------
[INFO] Pregled reaktora:
[INFO] 
[INFO] Shields4J 1.0.0 .................................... USPJEH [  9.603 s]
[INFO] test-core .......................................... USPJEH [  3.419 s]
[INFO] Shields4J klijent ................................... USPJEH [  9.793 s]
[INFO] TestNG slušatelj 1.0.0 .............................. USPJEH [01:23 min]
[INFO] ------------------------------------------------------------------------
[INFO] IZGRADNJA USPJEH
[INFO] ------------------------------------------------------------------------
[INFO] Ukupno vrijeme: 01:47 min
[INFO] Završeno u: 2019-04-21T04:05:46+03:00
[INFO] ------------------------------------------------------------------------

I ako nešto krene po zlu, zadatak će se sigurno uspjeti.

[INFO] Izvršavanje udaljenog slanja...
[INFO] 
[INFO]  * Udaljeno slanje u profil ID "9043b43f77dcc9"
[INFO]  * Stvorena repozitorij s ID "orgtouchbit-1038".
[INFO]  * Repozitorij za slanje na https://oss.sonatype.org:443/service/local/staging/deployByRepositoryId/orgtouchbit-1038
[INFO]  * Učitavanje lokalno poslanih artefakata u profil org.touchbit
[INFO]  * Učitavanje lokalno poslanih artefakata je završeno.
[INFO]  * Zatvaranje repozitorija za slanje s ID "orgtouchbit-1038".
Čekanje na završetak operacije...
.......
[ERROR] Neuspjeh pravila prilikom pokušaja zatvaranja repozitorija za slanje s ID "orgtouchbit-1039".
[ERROR] 
[ERROR] Izvještaj o neuspjehu pravila za slanje Nexus-a
[ERROR] ==================================
[ERROR] 
[ERROR] Neuspjesi repozitorija "orgtouchbit-1039"
[ERROR]   Neuspjesi pravila "signature-staging"
[ERROR]     * Nema javnog ključa: Ključ s id: (1f42b618d1cbe1b5) nije mogao biti lociran na <a href=http://keys.gnupg.net:11371/>http://keys.gnupg.net:11371/</a>. Učitajte svoj javni ključ i pokušajte operaciju ponovno.
...
[ERROR] Čišćenje lokalnog direktorija za slanje nakon neuspjeha pravila tijekom zatvaranja repozitorija za slanje: [orgtouchbit-1039]
[ERROR]  * Brisanje konteksta 9043b43f77dcc9.properties
[ERROR] Čišćenje udaljenih repozitorija za slanje nakon neuspjeha pravila tijekom zatvaranja repozitorija za slanje: [orgtouchbit-1039]
[ERROR]  * Brisanje neuspjelog repozitorija za slanje s ID "orgtouchbit-1039" (neuspjeh pravila tijekom zatvaranja repozitorija za slanje: [orgtouchbit-1039]).
[ERROR] Udaljeno slanje završeno s neuspjehom: Neuspjeh pravila za slanje!
[INFO] ------------------------------------------------------------------------
[INFO] Sažetak reaktora:
[INFO] 
[INFO] Shields4J 1.0.0 .................................... USPJEH [  4.073 s]
[INFO] test-core .......................................... USPJEH [  2.788 s]
[INFO] Shields4J klijent ................................... USPJEH [  3.962 s]
[INFO] TestNG slušatelj 1.0.0 .............................. NEUSPJEH [01:07 min]
[INFO] ------------------------------------------------------------------------
[INFO] NEUSPJEH IZGRADE
[INFO] ------------------------------------------------------------------------

Naš izbor je jedini. Ili izbrisati ovu verziju ili je objaviti.

Postavka GitLab CI za objavljivanje java projekta na Maven Central

Nakon objave, artefakti će se naći u Postavka GitLab CI za objavljivanje java projekta na Maven Central

off-topic

Za mene je bilo iznenađenje da maven indeksira druge javne repozitorije.
Morao sam dodati robots.txt jer je indeksirao moj stari repozitorij.

Na sadržaj

Zaključak

Što imamo

  • Odvojeni deploy-projekt u kojem se može realizirati nekoliko CI zadataka za učitavanje artefakata u javne repozitorije za različite programske jezike.
  • Deploy-projekt je izoliran od vanjskog ometanja i može se mijenjati samo od strane korisnika s ulogom Vlasnik i Održavatelj.
  • Odvojeni Specifični Runner s 'vrućim' cacheom za pokretanje samo deploy zadataka.
  • Objavljivanje snapshot/release verzija u javnom repozitoriju.
  • Automatska provjera release verzije na spremnost za objavu u maven central.
  • Zaštita od automatskog objavljivanja 'sirovih' verzija u maven central.
  • Izgradnja i objava snapshot verzija 'jednim klikom'.
  • Jedinstveni repozitorij za dobivanje snapshot/release verzija.
  • Opći pipeline za izgradnju/testiranje/publikaciju java projekta.

Postavljanje GitLab CI nije tako složena tema kako se na prvi pogled čini. Dovoljno je nekoliko puta postaviti CI "ključ u ruke" i eto, već niste početnik u tome. Osim toga, GitLab dokumentacija je prilično opširna. Ne bojte se napraviti prvi korak. Put se pojavljuje pod koracima onih koji idu (ne sjećam se tko je to rekao 🙂 ).

Bit ću zahvalan na povratnim informacijama.

U sljedećem članku ću govoriti o tome kako postaviti GitLab CI za konkurentno pokretanje zadataka s integracijskim testovima (s pokretanjem testiranih servisa uz pomoć docker-compose), ako imate samo jedan shell runner.

Na sadržaj

Izvor: habr.com

Kupite pouzdan hosting za web stranice s DDoS zaštitom, VPS VDS servere 🔥 Kupite pouzdan hosting za web stranice s DDoS zaštitom, VPS VDS servere | ProHoster