Questu articulu hè destinatu à i sviluppatori java chì anu bisognu di pubblicà rapidamente i so prudutti à i repositori centrali di sonatype è / o maven cù GitLab. In questu articulu, parleraghju di a creazione di gitlab-runner, gitlab-ci è maven-plugin per risolve stu prublema.
Prerequisiti:
- Archiviazione sicura di e chjave mvn è GPG.
- Esecuzione sicura di i travaglii CI publichi.
- Caricà artefatti (release / snapshot) à i repositori publichi.
- Verificazione automatica di e versioni di liberazione per a publicazione in Maven Central.
- Una soluzione generale per a carica di artefatti in un repository per parechji prughjetti.
- Simplicità è facilità d'usu.
Cuntenuti
Infurmazioni ghjugna
- Una descrizzione dettagliata di u mecanismu per a publicazione di artefatti à Maven Central via u Sonatype OSS Repository Hosting Service hè digià descritta in utilizatore , cusì mi riferiraghju à questu articulu in i posti ghjusti.
- Pre-registru à è cuminciate un bigliettu per apre u repository (per più dettagli, leghjite a sezione ). Dopu avè apertu u repository, a coppia di login/password JIRA (da quì in seguitu chjamatu u contu Sonatype) serà utilizata per carricà artefatti à u nexus Sonatype.
- In più, u prucessu di generazione di una chjave GPG hè descrittu assai seccu. Vede a sezione per più dettagli.
- Sè vo aduprate a cunsola Linux per generà una chjave GPG (gnupg/gnupg2), allora avete bisognu di stallà per generà entropia. Altrimenti, a generazione di chjave pò piglià assai tempu.
- servizii di almacenamentu publicu chiavi GPG
Configurazione di un prughjettu di implementazione in GitLab
- Prima di tuttu, avete bisognu di creà è cunfigurà un prughjettu in u quale u pipeline serà guardatu per a distribuzione di artefatti. Aghju chjamatu u mo prughjettu simplice è senza complicazioni -
- Dopu avè creatu u repository, avete bisognu di restringe l'accessu per cambià u repository.
Andà à u prughjettu -> Settings -> Repository -> Prutetti Branches. Sguassate tutte e regule è aghjunghje una sola regula cù Wildcard * cù u dirittu di spinghja è unisce solu per l'utilizatori cù u rolu di Maintainers. Sta regula hà da travaglià per tutti l'utilizatori di stu prughjettu è di u gruppu à quale stu prughjettu appartene.
- Se ci sò parechji mantene, allora a megliu suluzione seria di limità l'accessu à u prugettu in principiu.
Andà à u prughjettu -> Settings -> General -> Visibilità, funziunalità di u prugettu, permessi è stabilisce a visibilità di u prugettu à Private.
Aghju un prughjettu in accessu publicu, postu chì aghju utilizatu u mo propiu GitLab Runner è solu aghju accessu per mudificà u repository. Ebbè, in realtà ùn hè micca in u mo interessu di mostrà infurmazione privata in logs di pipeline publicu. - Stringhjendu e regule per cambià u repository
Andà à u prugettu -> Configurazione -> Repository -> Push Rules è stabilisce e bandiere Restrizzione di u Committer, Verificate se l'autore hè un utilizatore GitLab. Mi cunsigliu ancu di mette , è stabilisce a bandiera Reject unsigned commits. - In seguitu, avete bisognu di cunfigurà un trigger per eseguisce e attività
Andà à u prugettu -> Settings -> CI / CD -> Pipeline triggers è crea un novu trigger-token
Stu token pò esse aghjuntu immediatamente à a cunfigurazione generale di variàbili per un gruppu di prughjetti.
Andà à u gruppu -> Settings -> CI / CD -> Variables è aghjunghje una variabileDEPLOY_TOKENcù trigger-token in u valore.
GitLab Runner
Questa sezione descrive a cunfigurazione per eseguisce e attività nantu à a distribuzione utilizendu u corridore nativu (Specificu) è publicu (Shared).
Runner specificu
Aghju utilizatu i mo corridori, perchè prima di tuttu hè convenientu, veloce, economicu.
Per i corridori, ricumandemu Linux VDS cù 1 CPU, 2 GB RAM, 20 GB HDD. Prezzo di emissione ~ 3000₽ annu.
U mo corridore
Per u corridore aghju pigliatu VDS 4 CPU, 4 GB RAM, 50 GB SSD. Custa ~ 11000 ₽ è ùn si dispiace mai.
Aghju un totale di 7 macchine. 5 in aruba è 2 in ihor.
Dunque, avemu un corridore. Avà l'avemu stallatu.
Andemu à a macchina via SSH è installate java, git, maven, gnupg2.
Installazione di gitlab runner
- Crea un novu gruppu
runnersudo groupadd runner - Crea un repertoriu per a cache di Maven è attribuisce diritti di gruppu
runner
Pudete saltà stu passu se ùn avete micca pensatu à eseguisce parechji corridori nantu à a stessa macchina.mkdir -p /usr/cache/.m2/repository chown -R :runner /usr/cache chmod -R 770 /usr/cache - Crea un utilizatore
gitlab-deployerè aghjunghje à u gruppurunneruseradd -m -d /home/gitlab-deployer gitlab-deployer usermod -a -G runner gitlab-deployer - Aghjunghjite à u schedariu
/etc/ssh/sshd_configlinea dopuAllowUsers root@* [email protected] - Reboot
sshdsystemctl restart sshd - Stabbilisce una password per l'utilizatore
gitlab-deployer(pò esse simplice, postu chì ci hè una restrizione per localhost)passwd gitlab-deployer - Installa 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 - Andà à gitlab.com -> deploy-project -> Settings -> CI/CD -> Runners -> Specific Runners è copia u token di registrazione
Screen
- Registrazione di u corridore
gitlab-runner register --config /etc/gitlab-runner/gitlab-deployer-config.toml
prucessu
Runtime platform arch=amd64 os=linux pid=17594 revision=3001a600 version=11.10.0
Running in system-mode.
Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com/):
https://gitlab.com/
Please enter the gitlab-ci token for this runner:
REGISTRATION_TOKEN
Please enter the gitlab-ci description for this runner:
[ih1174328.vds.myihor.ru]: Deploy Runner
Please enter the gitlab-ci tags for this runner (comma separated):
deploy
Registering runner... succeeded runner=ZvKdjJhx
Please enter the executor: docker-ssh, parallels, virtualbox, docker-ssh+machine, kubernetes, docker, ssh, docker+machine, shell:
shell
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!- Verificate chì u corridore hè registratu. Andà à gitlab.com -> deploy-project -> Settings -> CI/CD -> Runners -> Specific Runners -> Runners attivati per stu prughjettu
Screen
- Aggiungi separatu serviziu
/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 - Cuminciamu u serviziu.
systemctl enable gitlab-deployer.service systemctl start gitlab-deployer.service systemctl status gitlab-deployer.service - Verificate chì u corridore corre.
Esempiu:
Generazione di chjave GPG
-
Da a stessa macchina andemu via ssh sottu l'utilizatore
gitlab-deployer(questu hè impurtante per a generazione di chjave GPG)ssh [email protected] -
Generemu una chjave rispondendu à e dumande. Aghju utilizatu u mo propiu nome è email.
Assicuratevi di specificà a password per a chjave. L'artefatti seranu firmati cù sta chjave.gpg --gen-key -
Verificendu
gpg --list-keys -a /home/gitlab-deployer/.gnupg/pubring.gpg ---------------------------------------- pub 4096R/00000000 2019-04-19 uid Petruha Petrov <[email protected]> sub 4096R/11111111 2019-04-19 -
Caricà a nostra chjave publica à u keyserver
gpg --keyserver keys.gnupg.net --send-key 00000000 gpg: sending key 00000000 to hkp server keys.gnupg.net
Configurazione di Maven
- Andemu sottu à l'utilizatori
gitlab-deployersu gitlab-deployer - Crea un annuariu Maven ripositoriu è ligà cù a cache (ùn fate micca sbagliu)
Stu passu pò esse saltatu sè ùn avete micca pensatu à eseguisce parechji corridori nantu à a stessa macchina.mkdir -p ~/.m2/repository ln -s /usr/cache/.m2/repository /home/gitlab-deployer/.m2/repository - Crea una chjave maestra
mvn --encrypt-master-password password {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=} - Crea u schedariu ~/.m2/settings-security.xml
<settingsSecurity> <master>{hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}</master> </settingsSecurity> - Criptà a password da u contu Sonatype
mvn --encrypt-password SONATYPE_PASSWORD {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J} - Crea u schedariu ~/.m2/settings.xml
<settings> <profiles> <profile> <id>env</id> <activation> <activeByDefault>true</activeByDefault> </activation> <properties> <gpg.passphrase>GPG_SECRET_KEY_PASSPHRASE</gpg.passphrase> </properties> </profile> </profiles> <servers> <server> <id>sonatype</id> <username>SONATYPE_USERNAME</username> <password>{98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J}</password> </server> </servers> </settings>
induve,
GPG_SECRET_KEY_PASSPHRASE - Password chjave GPG
SONATYPE_USERNAME - login di u contu sonatype
Questu compie a cunfigurazione di u corridore, pudete andà in a sezione
Runner spartutu
Generazione di chjave GPG
-
Prima di tuttu, avete bisognu di creà una chjave GPG. Per fà questu, installate gnupg.
yum install -y gnupg -
Generemu una chjave rispondendu à e dumande. Aghju utilizatu u mo propiu nome è email. Assicuratevi di specificà a password per a chjave.
gpg --gen-key -
Ritruvà l'infurmazioni chjave
gpg --list-keys -a pub rsa3072 2019-04-24 [SC] [expires: 2021-04-23] 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 uid [ultimate] tttemp <[email protected]> sub rsa3072 2019-04-24 [E] [expires: none] -
Caricà a nostra chjave publica à u keyserver
gpg --keyserver keys.gnupg.net --send-key 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 gpg: sending key 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 to hkp server keys.gnupg.net -
Ottene una chjave privata
gpg --export-secret-keys --armor 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 -----BEGIN PGP PRIVATE KEY BLOCK----- lQWGBFzAqp8BDADN41CPwJ/gQwiKEbyA902DKw/WSB1AvZQvV/ZFV77xGeG4K7k5 ... =2Wd2 -----END PGP PRIVATE KEY BLOCK----- -
Vai à i paràmetri di u prugettu -> Settings -> CI / CD -> Variables è salvà a chjave privata in una variàbile
GPG_SECRET_KEY
Configurazione di Maven
- Crea una chjave maestra
mvn --encrypt-master-password password {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=} - Andà à i paràmetri di u prugettu -> Settings -> CI / CD -> Variables è salvà in una variàbile
SETTINGS_SECURITY_XMLe seguenti linee:<settingsSecurity> <master>{hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}</master> </settingsSecurity> - Criptà a password da u contu Sonatype
mvn --encrypt-password SONATYPE_PASSWORD {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J} - Andà à i paràmetri di u prugettu -> Settings -> CI / CD -> Variables è salvà in una variàbile
SETTINGS_XMLe seguenti linee:<settings> <profiles> <profile> <id>env</id> <activation> <activeByDefault>true</activeByDefault> </activation> <properties> <gpg.passphrase>GPG_SECRET_KEY_PASSPHRASE</gpg.passphrase> </properties> </profile> </profiles> <servers> <server> <id>sonatype</id> <username>sonatype_username</username> <password>{98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J}</password> </server> </servers> </settings>
induve,
GPG_SECRET_KEY_PASSPHRASE - Password chjave GPG
SONATYPE_USERNAME - login di u contu sonatype
Impulsà l'imagine docker
-
Creemu un Dockerfile abbastanza simplice per eseguisce e attività nantu à a distribuzione cù a versione desiderata di Java. Quì sottu hè un esempiu per 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/ -
Custruì un containeru per u vostru prughjettu
docker build -t registry.gitlab.com/group/deploy . -
Autentificamu è carichemu u containeru in u registru.
docker login -u USER -p PASSWORD registry.gitlab.com docker push registry.gitlab.com/group/deploy
GitLab CI
Impulsà u prughjettu
Aghjunghjite u schedariu .gitlab-ci.yml à a radica di u prugettu di implementazione
U script presenta dui compiti di implementazione mutuamente esclusivi. Corridore specificu o Corridore spartutu rispettivamente.
.gitlab-ci.yml
stages:
- deploy
Specific Runner:
extends: .java_deploy_template
# Задача будет выполняться на вашем shell-раннере
tags:
- deploy
Shared Runner:
extends: .java_deploy_template
# Задача будет выполняться на публичном docker-раннере
tags:
- docker
# Образ из раздела GitLab Runner -> Shared Runner -> Docker
image: registry.gitlab.com/group/deploy-project:latest
before_script:
# Импортируем GPG ключ
- printf "${GPG_SECRET_KEY}" | gpg --batch --import
# Сохраняем maven конфигурацию
- printf "${SETTINGS_SECURITY_XML}" > ~/.m2/settings-security.xml
- printf "${SETTINGS_XML}" > ~/.m2/settings.xml
.java_deploy_template:
stage: deploy
# Задача сработает по триггеру, если передана переменная DEPLOY со значением java
only:
variables:
- $DEPLOY == "java"
variables:
# отключаем клонирование текущего проекта
GIT_STRATEGY: none
script:
# Предоставляем возможность хранения пароля в незашифрованном виде
- git config --global credential.helper store
# Сохраняем временные креды пользователя gitlab-ci-token
# Токен работает для всех публичных проектов gitlab.com и для проектов группы
- echo "https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com" >> ~/.git-credentials
# Полностью чистим текущую директорию
- rm -rf .* *
# Клонируем проект который, будем деплоить в Sonatype Nexus
- git clone ${DEPLOY_CI_REPOSITORY_URL} .
# Переключаемся на нужный коммит
- git checkout ${DEPLOY_CI_COMMIT_SHA} -f
# Если хоть один pom.xml содержит параметр autoReleaseAfterClose валим сборку.
# В противном случае есть риск залить сырые артефакты в maven central
- >
for pom in $(find . -name pom.xml); do
if [[ $(grep -q autoReleaseAfterClose "$pom" && echo $?) == 0 ]]; then
echo "File $pom contains prohibited setting: <autoReleaseAfterClose>";
exit 1;
fi;
done
# Если параметр DEPLOY_CI_COMMIT_TAG пустой, то принудительно ставим SNAPSHOT-версию
- >
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
# Запускаем задачу на сборку и деплой артефактов
- mvn clean deploy -DskipTests=true
Prughjettu Java
In i prughjetti java chì deve esse caricati à i repositori publichi, avete bisognu di aghjunghje 2 passi per scaricà e versioni Release è Snapshot.
.gitlab-ci.yml
stages:
- build
- test
- verify
- deploy
<...>
Release:
extends: .trigger_deploy
# Запускать задачу только пo тегу.
only:
- tags
Snapshot:
extends: .trigger_deploy
# Запускаем задачу на публикацию SNAPSHOT версии вручную
when: manual
# Не запускать задачу, если проставлен тег.
except:
- tags
.trigger_deploy:
stage: deploy
variables:
# Отключаем клонирование текущего проекта
GIT_STRATEGY: none
# Ссылка на триггер deploy-задачи
URL: "https://gitlab.com/api/v4/projects/<deploy project ID>/trigger/pipeline"
# Переменные deploy-задачи
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:
# Не использую cURL, так как с флагами --fail --show-error
# он не выводит тело ответа, если HTTP код 400 и более
- wget --content-on-error -qO- ${URL} --post-data ${POST_DATA}In questa suluzione, aghju andatu un pocu più è decisu di utilizà un mudellu CI per i prughjetti java.
More details
Aghju creatu un prughjettu separatu in quale hà postu u mudellu CI per i prughjetti java .
cumuni.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
In u risultatu, in i prughjetti java stessi, .gitlab-ci.yml pare assai compactu è micca verbose.
.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
cunfigurazione pom.xml
Stu tema hè descrittu in grande dittagli. в , cusì descriveraghju alcune di e sfumature di l'usu di plugins. Descriveraghju ancu quantu facilmente è naturali pudete aduprà nexus-staging-maven-pluginse ùn vulete micca o ùn pudete micca aduprà org.sonatype.oss:oss-parent cum'è parent per u vostru prughjettu.
maven-install-plugin
Installa moduli in u repositoriu lucale.
Moltu utile per a verificazione lucale di suluzioni in altri prughjetti, è ancu un checksum.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
<executions>
<execution>
<id>install-project</id>
<!-- Если у вас многомодульный проект с деплоем родительского помика -->
<phase>install</phase>
<!-- Явно указываем файлы для локальной установки -->
<configuration>
<file>target/${project.artifactId}-${project.version}.jar</file>
```target/${project.artifactId}-${project.version}-sources.jar</sources>
<pomFile>dependency-reduced-pom.xml</pomFile>
<!-- Принудительное обновление метаданных проекта -->
<updateReleaseInfo>true</updateReleaseInfo>
<!-- Контрольные суммы для проверки целостности -->
<createChecksum>true</createChecksum>
</configuration>
</execution>
</executions>
</plugin>
maven-javadoc-plugin
Generazione di javadoc per u prugettu.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>jar</goal>
</goals>
<!-- Генерация javadoc должна быть после фазы генерации ресурсов -->
<phase>prepare-package</phase>
<configuration>
<!-- Очень помогает в публичных проектах -->
<failOnError>true</failOnError>
<failOnWarnings>true</failOnWarnings>
<!-- Убирает ошибку поиска документации в target директории -->
<detectOfflineLinks>false</detectOfflineLinks>
</configuration>
</execution>
</executions>
</plugin>Sì avete un modulu chì ùn cuntene micca java (per esempiu solu risorse)
O ùn vulete micca generà javadoc in principiu, allora per aiutà maven-jar-plugin
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<executions>
<execution>
<id>empty-javadoc-jar</id>
<phase>generate-resources</phase>
<goals>
<goal>jar</goal>
</goals>
<configuration>
<classifier>javadoc</classifier>
<classesDirectory>${basedir}/javadoc</classesDirectory>
</configuration>
</execution>
</executions>
</plugin>
maven-gpg-plugin
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<executions>
<execution>
<id>sign-artifacts</id>
<!-- Сборка будет падать, если отсутствует GPG ключ -->
<!-- Подписываем артефакты только на фазе deploy -->
<phase>deploy</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
nexus-staging-maven-plugin
Cunfigurazione:
<project>
<!-- ... -->
<build>
<plugins>
<!-- ... -->
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
</plugin>
</plugins>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<extensions>true</extensions>
<configuration>
<serverId>sonatype</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<!-- Обновляем метаданные, чтобы пометить артефакт как release -->
<!-- Не влияет на snapshot версии -->
<updateReleaseInfo>true</updateReleaseInfo>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<configuration>
<!-- Отключаем плагин -->
<skip>true</skip>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
<distributionManagement>
<snapshotRepository>
<id>sonatype</id>
<name>Nexus Snapshot Repository</name>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</snapshotRepository>
<repository>
<id>sonatype</id>
<name>Nexus Release Repository</name>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>
</project>Se tenete un prughjettu multi-modulu, è ùn avete micca bisognu di carricà un modulu specificu à u repository, allora avete bisognu di aghjunghje à u pom.xml di stu modulu. nexus-staging-maven-plugin cù bandiera skipNexusStagingDeployMojo
<build>
<plugins>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<configuration>
<skipNexusStagingDeployMojo>true</skipNexusStagingDeployMojo>
</configuration>
</plugin>
</plugins>
</build>Dopu avè caricatu e versioni di snapshot / release sò dispunibili in
<repositories>
<repository>
<id>SonatypeNexus</id>
<url>https://oss.sonatype.org/content/groups/staging/</url>
<!-- Не надо указывать флаги snapshot/release для репозитория -->
</repository>
</repositories>Più plus
- Una lista assai ricca di miri per travaglià cù u repository nexus (
mvn help:describe -Dplugin=org.sonatype.plugins:nexus-staging-maven-plugin). - Verificazione di liberazione automatica per a scaricabilità in Maven Central
risultatu
Publicà una versione SNAPSHOT
Quandu custruisce un prughjettu, hè pussibule di inizià manualmente un compitu per scaricà a versione SNAPSHOT in nexus
Quandu sta attività hè lanciata, u compitu currispundente in u prughjettu di implementazione hè attivatu ().
log tagliatu
Running with gitlab-runner 11.10.0 (3001a600)
on Deploy runner JSKWyxUw
Using Shell executor...
Running on ih1174328.vds.myihor.ru...
Skipping Git repository setup
Skipping Git checkout
Skipping Git submodules setup
$ 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} .
Cloning into 'shields4j'...
$ git checkout ${DEPLOY_CI_COMMIT_SHA}
Note: checking out '850f86aa317194395c5387790da1350e437125a7'.
You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another checkout.
If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -b with the checkout command again. Example:
git checkout -b new_branch_name
HEAD is now at 850f86a... skip deploy test-core
$ for pom in $(find . -name pom.xml); do # collapsed multi-line command
$ if [[ "${DEPLOY_CI_COMMIT_TAG}" != "" ]]; then # collapsed multi-line command
[INFO] Scanning for projects...
[INFO] Inspecting build with total of 4 modules...
[INFO] Installing Nexus Staging features:
[INFO] ... total of 4 executions of maven-deploy-plugin replaced with nexus-staging-maven-plugin
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO]
[INFO] Shields4J [pom]
[INFO] test-core [jar]
[INFO] Shields4J client [jar]
[INFO] TestNG listener [jar]
[INFO]
[INFO] --------------< org.touchbit.shields4j:shields4j-parent >---------------
[INFO] Building Shields4J 1.0.0 [1/4]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] --- versions-maven-plugin:2.5:set (default-cli) @ shields4j-parent ---
[INFO] Searching for local aggregator root...
[INFO] Local aggregation root: /home/gitlab-deployer/JSKWyxUw/0/TouchBIT/deploy/shields4j
[INFO] Processing change of org.touchbit.shields4j:shields4j-parent:1.0.0 -> 1.0.0-SNAPSHOT
[INFO] Processing org.touchbit.shields4j:shields4j-parent
[INFO] Updating project org.touchbit.shields4j:shields4j-parent
[INFO] from version 1.0.0 to 1.0.0-SNAPSHOT
[INFO]
[INFO] Processing org.touchbit.shields4j:client
[INFO] Updating parent org.touchbit.shields4j:shields4j-parent
[INFO] from version 1.0.0 to 1.0.0-SNAPSHOT
[INFO] Updating dependency org.touchbit.shields4j:test-core
[INFO] from version 1.0.0 to 1.0.0-SNAPSHOT
[INFO]
[INFO] Processing org.touchbit.shields4j:test-core
[INFO] Updating parent org.touchbit.shields4j:shields4j-parent
[INFO] from version 1.0.0 to 1.0.0-SNAPSHOT
[INFO]
[INFO] Processing org.touchbit.shields4j:testng
[INFO] Updating parent org.touchbit.shields4j:shields4j-parent
[INFO] from version 1.0.0 to 1.0.0-SNAPSHOT
[INFO] Updating dependency org.touchbit.shields4j:client
[INFO] from version 1.0.0 to 1.0.0-SNAPSHOT
[INFO] Updating dependency org.touchbit.shields4j:test-core
[INFO] from version 1.0.0 to 1.0.0-SNAPSHOT
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] Shields4J 1.0.0 .................................... SUCCESS [ 0.992 s]
[INFO] test-core .......................................... SKIPPED
[INFO] Shields4J client ................................... SKIPPED
[INFO] TestNG listener 1.0.0 .............................. SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.483 s
[INFO] Finished at: 2019-04-21T02:40:42+03:00
[INFO] ------------------------------------------------------------------------
$ mvn clean deploy -DskipTests=${SKIP_TESTS}
[INFO] Scanning for projects...
[INFO] Inspecting build with total of 4 modules...
[INFO] Installing Nexus Staging features:
[INFO] ... total of 4 executions of maven-deploy-plugin replaced with nexus-staging-maven-plugin
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO]
[INFO] Shields4J [pom]
[INFO] test-core [jar]
[INFO] Shields4J client [jar]
[INFO] TestNG listener [jar]
[INFO]
[INFO] --------------< org.touchbit.shields4j:shields4j-parent >---------------
[INFO] Building Shields4J 1.0.0-SNAPSHOT [1/4]
[INFO] --------------------------------[ pom ]---------------------------------
...
DELETED
...
[INFO] * Bulk deploy of locally gathered snapshot artifacts finished.
[INFO] Remote deploy finished with success.
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] Shields4J 1.0.0-SNAPSHOT ........................... SUCCESS [ 2.375 s]
[INFO] test-core .......................................... SUCCESS [ 3.929 s]
[INFO] Shields4J client ................................... SUCCESS [ 3.815 s]
[INFO] TestNG listener 1.0.0-SNAPSHOT ..................... SUCCESS [ 36.134 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 47.629 s
[INFO] Finished at: 2019-04-21T02:41:32+03:00
[INFO] ------------------------------------------------------------------------In u risultatu, a versione nexus hè caricata .
Tutte e versioni di snapshot ponu esse eliminate da u repository in u situ sottu u vostru contu.
Publicazione di a versione di liberazione
Quandu u tag hè stabilitu, u compitu currispundente in u prughjettu di implementazione hè attivatu automaticamente per carica a versione di liberazione in nexus ().
A più bona parte hè chì a liberazione vicinu attiva automaticamente in nexus.
[INFO] Performing remote staging...
[INFO]
[INFO] * Remote staging into staging profile ID "9043b43f77dcc9"
[INFO] * Created staging repository with ID "orgtouchbit-1037".
[INFO] * Staging repository at https://oss.sonatype.org:443/service/local/staging/deployByRepositoryId/orgtouchbit-1037
[INFO] * Uploading locally staged artifacts to profile org.touchbit
[INFO] * Upload of locally staged artifacts finished.
[INFO] * Closing staging repository with ID "orgtouchbit-1037".
Waiting for operation to complete...
.........
[INFO] Remote staged 1 repositories, finished with success.
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] Shields4J 1.0.0 .................................... SUCCESS [ 9.603 s]
[INFO] test-core .......................................... SUCCESS [ 3.419 s]
[INFO] Shields4J client ................................... SUCCESS [ 9.793 s]
[INFO] TestNG listener 1.0.0 .............................. SUCCESS [01:23 min]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 01:47 min
[INFO] Finished at: 2019-04-21T04:05:46+03:00
[INFO] ------------------------------------------------------------------------È s'è qualcosa andò male, allora u compitu fallerà
[INFO] Performing remote staging...
[INFO]
[INFO] * Remote staging into staging profile ID "9043b43f77dcc9"
[INFO] * Created staging repository with ID "orgtouchbit-1038".
[INFO] * Staging repository at https://oss.sonatype.org:443/service/local/staging/deployByRepositoryId/orgtouchbit-1038
[INFO] * Uploading locally staged artifacts to profile org.touchbit
[INFO] * Upload of locally staged artifacts finished.
[INFO] * Closing staging repository with ID "orgtouchbit-1038".
Waiting for operation to complete...
.......
[ERROR] Rule failure while trying to close staging repository with ID "orgtouchbit-1039".
[ERROR]
[ERROR] Nexus Staging Rules Failure Report
[ERROR] ==================================
[ERROR]
[ERROR] Repository "orgtouchbit-1039" failures
[ERROR] Rule "signature-staging" failures
[ERROR] * No public key: Key with id: (1f42b618d1cbe1b5) was not able to be located on <a href=http://keys.gnupg.net:11371/>http://keys.gnupg.net:11371/</a>. Upload your public key and try the operation again.
...
[ERROR] Cleaning up local stage directory after a Rule failure during close of staging repositories: [orgtouchbit-1039]
[ERROR] * Deleting context 9043b43f77dcc9.properties
[ERROR] Cleaning up remote stage repositories after a Rule failure during close of staging repositories: [orgtouchbit-1039]
[ERROR] * Dropping failed staging repository with ID "orgtouchbit-1039" (Rule failure during close of staging repositories: [orgtouchbit-1039]).
[ERROR] Remote staging finished with a failure: Staging rules failure!
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] Shields4J 1.0.0 .................................... SUCCESS [ 4.073 s]
[INFO] test-core .......................................... SUCCESS [ 2.788 s]
[INFO] Shields4J client ................................... SUCCESS [ 3.962 s]
[INFO] TestNG listener 1.0.0 .............................. FAILURE [01:07 min]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------Per via di u risultatu, ci hè una sola scelta. O sguassate sta versione o publicate.
Dopu à a liberazione, dopu qualchì tempu, l'artefatti seranu in
offtopic
Hè stata una rivelazione per mè chì Maven indexa altri repositori publichi.
Aviu avutu a carica di robots.txt perchè hà indexatu u mo vechju repository.
cunchiusioni
Ciò chì avemu
- Un prughjettu di implementazione separatu in u quale pudete implementà parechje attività CI per a carica di artefatti à i repositori publichi per diverse lingue di sviluppu.
- U prughjettu di implementazione hè isolatu da l'interferenza esterna è pò esse mudificatu solu da l'utilizatori cù i roli di u pruprietariu è di u mantenimentu.
- Un corridore specificu separatu cù una cache "calda" per eseguisce solu attività di implementazione.
- Publicazione di versioni snapshot/release in un repositoriu publicu.
- Verificazione automatica di a versione di liberazione per a preparazione per a publicazione in Maven Central.
- Prutezzione contr'à a publicazione automatica di versioni "crue" in Maven Central.
- Custruite è pubblicà versioni snapshot "à cliccà".
- Repositoriu unicu per uttene versioni di snapshot / rilascio.
- Pipeline generale per custruisce / pruvà / publicà un prughjettu java.
L'installazione di GitLab CI ùn hè micca un tema cusì complicatu cum'è pare à prima vista. Hè abbastanza à stallà CI nantu à una basa turnkey un paru di volte, è avà site luntanu da un dilettante in questa materia. Inoltre, a documentazione di GitLab hè assai redundante. Ùn àbbia paura di fà u primu passu. A strada si prisenta sottu à i passi di a persona chì cammina (ùn mi ricordu micca chì l'hà dettu :)
Seraghju felice di feedback.
In u prossimu articulu, vi mustraraghju cumu cunfigurà GitLab CI per eseguisce e funzioni di teste di integrazione in modu competitivu (eseguisce servizii di prova cù docker-compose) se avete solu un shell runner.
Source: www.habr.com