Бул макала GitLab аркылуу өз өнүмдөрүн sonatype жана/же maven борбордук репозиторийлерине тез арада жарыялоо керек болгон java иштеп чыгуучуларына арналган. Бул макалада мен бул маселени чечүү үчүн gitlab-runner, gitlab-ci жана maven-плагинди орнотуу жөнүндө сүйлөшөм.
Алдын ала шарттар:
- mvn жана GPG ачкычтарын коопсуз сактоо.
- Коомдук CI тапшырмаларын коопсуз аткаруу.
- Артефакттарды (чыгаруу/сүрөт) коомдук репозиторийлерге жүктөө.
- Maven Centralда жарыялоо үчүн релиз версияларын автоматтык түрдө текшерүү.
- Артефакттарды бир нече долбоорлор үчүн репозиторийге жүктөө үчүн жалпы чечим.
- Жөнөкөйлүгү жана колдонуунун жөнөкөйлүгү.
ыраазы
жалпы маалымат
- Sonatype OSS Repository Хостинг кызматы аркылуу Maven Centralга артефакттарды жарыялоо механизминин кеңири сүрөттөлүшү буга чейин сүрөттөлгөн. колдонуучу , ошондуктан мен бул макалага керектүү жерлерде кайрылам.
- дарегинде алдын ала катталыңыз жана репозиторийди ачуу үчүн билетти баштаңыз (көбүрөөк маалымат үчүн бөлүмдү окуңуз ). Репозиторийди ачкандан кийин JIRA логин/сырсөз жубу (мындан ары Sonatype эсеби деп аталат) Artefacts Sonatype nexus үчүн жүктөө үчүн колдонулат.
- Андан ары, GPG ачкычын түзүү жараяны абдан кургак сүрөттөлгөн. Көбүрөөк маалымат алуу үчүн бөлүмдү караңыз.
- Эгер сиз GPG ачкычын (gnupg/gnupg2) түзүү үчүн Linux консолун колдонуп жатсаңыз, анда орнотуу керек энтропияны түзүү. Болбосо, ачкыч генерация абдан көп убакыт талап кылынышы мүмкүн.
- Сактоо кызматтары мамлекеттик GPG ачкычтары
GitLab ичинде жайылтуу долбоорун орнотуу
- Биринчиден, артефакттарды жайгаштыруу үчүн түтүк сактала турган долбоорду түзүп, конфигурациялашыңыз керек. Мен өзүмдүн долбоорумду жөнөкөй жана жөнөкөй деп атадым -
- Репозиторийди түзгөндөн кийин, репозиторийди өзгөртүү үчүн мүмкүнчүлүктү чектөө керек.
Долбоор -> Орнотуулар -> Репозиторий -> Корголгон бутактарга өтүңүз. Биз бардык эрежелерди жок кылабыз жана Wildcard * менен бир эрежени кошуп, Тейлөөчүлөр ролу бар колдонуучулар үчүн гана түртүү жана бириктирүү укугубуз бар. Бул эреже бул долбоордун бардык колдонуучулары үчүн жана бул долбоор таандык болгон топ үчүн иштейт.
- Эгерде бир нече тейлөөчүлөр болсо, анда эң жакшы чечим долбоорго кирүү мүмкүнчүлүгүн чектөө болот.
Долбоорго өтүңүз -> Орнотуулар -> Жалпы -> Көрүнүү, долбоордун өзгөчөлүктөрү, уруксаттар жана Долбоордун көрүнүшүн төмөнкүгө орнотуңуз жеке.
Менде жалпыга жеткиликтүү долбоор бар, анткени мен өзүмдүн GitLab Runnerимди колдоном жана репозиторийди өзгөртүүгө мен гана мүмкүнчүлүгүм бар. Чындыгында, жалпыга ачык түтүк журналдарында жеке маалыматты көрсөтүү менин кызыкчылыгымда эмес. - Репозиторийди өзгөртүү эрежелерин катаалдаштыруу
Долбоорго өтүңүз -> Орнотуулар -> Репозиторий -> Push Rules жана желекчелерди орнотуңуз Committer чектөө, Автордун GitLab колдонуучусу экендигин текшериңиз. Мен да орнотууну сунуштайм , жана кол коюлбаган тапшырмаларды четке кагуу желекчесин коюңуз. - Андан кийин, тапшырмаларды аткаруу үчүн триггерди конфигурациялашыңыз керек
Долбоор -> Орнотуулар -> CI / CD -> Түтүк триггерлерине өтүңүз жана жаңы триггер-токенди түзүңүз
Бул белгини долбоорлордун тобу үчүн өзгөрмөлөрдүн жалпы конфигурациясына дароо кошууга болот.
Топко өтүңүз -> Орнотуулар -> CI / CD -> Variables жана өзгөрмө кошуңузDEPLOY_TOKENмааниде триггер-токен менен.
GitLab Runner
Бул бөлүмдө түпнуска (Өзгөчө) жана жалпы (Бөлүшүлгөн) жөө күлүктү колдонуу менен жайылтууда аткарылуучу тапшырмалар үчүн конфигурация сүрөттөлөт.
Spesifik Runner
Мен өзүмдүн жөө күлүктөрүмдү колдоном, анткени бул биринчи кезекте ыңгайлуу, тез, арзан.
Жөө күлүккө 1 CPU, 2 ГБ оперативдүү эс, 20 ГБ HDD менен Linux VDS сунуштайм. Чыгаруунун баасы жылына ~ 3000₽.
Менин күлүгүм
Жөө күлүк үчүн мен VDS 4 CPU, 4 ГБ оперативдүү эстутум, 50 ГБ SSD алдым. Баасы ~11000₽ жана эч качан өкүнгөн эмес.
Менде жалпы 7 машина бар. Аруба боюнча 5 жана Ихор боюнча 2.
Демек, бизде күлүк бар. Эми биз аны орнотобуз.
Биз SSH аркылуу машинага барып, java, git, maven, gnupg2 орнотобуз.
gitlab runner орнотулууда
- Жаңы топ түзүңүз
runnersudo groupadd runner - maven кэши үчүн каталог түзүп, топтун укуктарын дайындаңыз
runner
Эгер бир эле машинада бир нече жөө күлүктү чуркоону пландабасаңыз, бул кадамды өткөрүп жиберсеңиз болот.mkdir -p /usr/cache/.m2/repository chown -R :runner /usr/cache chmod -R 770 /usr/cache - Колдонуучу түзүү
gitlab-deployerжана группага кошуңузrunneruseradd -m -d /home/gitlab-deployer gitlab-deployer usermod -a -G runner gitlab-deployer - Файлга кошуу
/etc/ssh/sshd_configкийинки сапAllowUsers root@* [email protected] - Кайра жүктөө
sshdsystemctl restart sshd - Колдонуучуга сырсөз коюңуз
gitlab-deployer(бул жөнөкөй болушу мүмкүн, анткени localhost үчүн чектөө бар)passwd gitlab-deployer - 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 - gitlab.com -> deploy-project -> Орнотуулар -> CI/CD -> Rnners -> Specific Runners дарегине өтүңүз жана каттоо белгисин көчүрүңүз
Экран
- Жөө күлүктү каттоо
gitlab-runner register --config /etc/gitlab-runner/gitlab-deployer-config.toml
тартиби
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!- Жөө күлүктүн катталганын текшериңиз. Барыңыз gitlab.com -> deploy-project -> Орнотуулар -> CI/CD -> Runners -> Specific Runners -> Runners бул долбоор үчүн жандырылды
Экран
- кошуу өзүнчө кызмат
/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 - Кызматты баштайбыз.
systemctl enable gitlab-deployer.service systemctl start gitlab-deployer.service systemctl status gitlab-deployer.service - Жөө күлүктүн чуркап жатканын текшериңиз.
мисал
GPG ачкычын түзүү
-
Ошол эле машинадан биз колдонуучунун астындагы ssh аркылуу барабыз
gitlab-deployer(бул GPG ачкычын түзүү үчүн маанилүү)ssh [email protected] -
Суроолорго жооп берүү менен ачкычты түзөбүз. Мен өз атымды жана электрондук почтамды колдондум.
Ачкычтын сырсөзүн көрсөтүүнү унутпаңыз. Артефакттарга бул ачкыч менен кол коюлат.gpg --gen-key -
текшерүү
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 -
Биздин ачык ачкычты ачкыч серверине жүктөө
gpg --keyserver keys.gnupg.net --send-key 00000000 gpg: sending key 00000000 to hkp server keys.gnupg.net
Maven орнотуу
- Биз колдонуучунун астына киребиз
gitlab-deployersu gitlab-deployer - maven каталогун түзүү жай жана кэш менен шилтеме (ката кетирбеңиз)
Эгер бир эле машинада бир нече жөө күлүктү чуркоо планы жок болсо, бул кадамды өткөрүп жиберсеңиз болот.mkdir -p ~/.m2/repository ln -s /usr/cache/.m2/repository /home/gitlab-deployer/.m2/repository - Башкы ачкычты түзүңүз
mvn --encrypt-master-password password {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=} - ~/.m2/settings-security.xml файлын түзүңүз
<settingsSecurity> <master>{hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}</master> </settingsSecurity> - Sonatype аккаунтунан сырсөздү шифрлөө
mvn --encrypt-password SONATYPE_PASSWORD {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J} - ~/.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>
кайда,
GPG_SECRET_KEY_PASSPHRASE - GPG ачкыч сырсөзү
SONATYPE_USERNAME - sonatype каттоо эсебине кирүү
Бул жөө күлүктү орнотууну аяктайт, сиз бөлүмгө өтсөңүз болот
Shared Runner
GPG ачкычын түзүү
-
Биринчиден, сиз GPG ачкычын түзүшүңүз керек. Бул үчүн, gnupg орнотуңуз.
yum install -y gnupg -
Суроолорго жооп берүү менен ачкычты түзөбүз. Мен өз атымды жана электрондук почтамды колдондум. Ачкычтын сырсөзүн көрсөтүүнү унутпаңыз.
gpg --gen-key -
Негизги маалыматты алуу
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] -
Биздин ачык ачкычты ачкыч серверине жүктөө
gpg --keyserver keys.gnupg.net --send-key 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 gpg: sending key 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 to hkp server keys.gnupg.net -
Жеке ачкыч алуу
gpg --export-secret-keys --armor 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 -----BEGIN PGP PRIVATE KEY BLOCK----- lQWGBFzAqp8BDADN41CPwJ/gQwiKEbyA902DKw/WSB1AvZQvV/ZFV77xGeG4K7k5 ... =2Wd2 -----END PGP PRIVATE KEY BLOCK----- -
Долбоордун жөндөөлөрүнө өтүңүз -> Орнотуулар -> CI / CD -> Variables жана купуя ачкычты өзгөрмөдө сактаңыз
GPG_SECRET_KEY
Maven орнотуу
- Башкы ачкычты түзүңүз
mvn --encrypt-master-password password {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=} - Долбоордун жөндөөлөрүнө өтүңүз -> Орнотуулар -> CI / CD -> Variables жана өзгөрмөдө сактаңыз
SETTINGS_SECURITY_XMLтөмөнкү саптар:<settingsSecurity> <master>{hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}</master> </settingsSecurity> - Sonatype аккаунтунан сырсөздү шифрлөө
mvn --encrypt-password SONATYPE_PASSWORD {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J} - Долбоордун жөндөөлөрүнө өтүңүз -> Орнотуулар -> CI / CD -> Variables жана өзгөрмөдө сактаңыз
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>
кайда,
GPG_SECRET_KEY_PASSPHRASE - GPG ачкыч сырсөзү
SONATYPE_USERNAME - sonatype каттоо эсебине кирүү
Докер сүрөтүн жайылтуу
-
Биз Javaнын каалаган версиясы менен жайгаштыруу боюнча тапшырмаларды аткаруу үчүн абдан жөнөкөй Dockerfile түзөбүз. Төмөндө альп үчүн бир мисал келтирилген.
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/ -
Долбооруңуз үчүн контейнер куруу
docker build -t registry.gitlab.com/group/deploy . -
Контейнердин аныктыгын текшерип, реестрге жүктөйбүз.
docker login -u USER -p PASSWORD registry.gitlab.com docker push registry.gitlab.com/group/deploy
GitLab CI
Долбоорду жайылтуу
.gitlab-ci.yml файлын жайылтуу долбоорунун тамырына кошуңуз
Скрипт эки бири-бирин эксклюзивдүү жайылтуу тапшырмасын берет. Тиешелүүлүгүнө жараша конкреттүү Runner же Shared Runner.
.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
Java долбоору
Коомдук репозиторийлерге жүктөлүшү керек болгон java долбоорлорунда Чыгаруу жана Снапшот версияларын жүктөп алуу үчүн 2 кадамды кошушуңуз керек.
.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}Бул чечимде мен бир аз алдыга барып, java долбоорлору үчүн бир CI шаблонун колдонууну чечтим.
Кененирээк
Өзүмчө долбоор түздүм анда ал java долбоорлору үчүн CI үлгүсүн жайгаштырган .
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
Натыйжада, java долбоорлорунун өзүндө .gitlab-ci.yml абдан компакттуу жана кеңири эмес көрүнөт
.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
pom.xml конфигурациясы
Бул тема абдан майда-чүйдөсүнө чейин баяндалган. в , ошондуктан мен плагиндерди колдонуунун айрым нюанстарын сүрөттөп берем. Мен ошондой эле сиз кантип оңой жана табигый түрдө колдоно аларыңызды сүрөттөп берем nexus-staging-maven-pluginэгер сиз каалабасаңыз же org.sonatype.oss:oss-parent проектиңиз үчүн ата-эне катары колдоно албасаңыз.
maven-орнотуу-плагин
Жергиликтүү репозиторийге модулдарды орнотот.
Башка долбоорлордогу чечимдерди жергиликтүү текшерүү, ошондой эле текшерүү суммасы үчүн абдан пайдалуу.
<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-плагин
Долбоор үчүн Javadoc түзүлүүдө.
<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>Эгер сизде java камтылбаган модулуңуз болсо (мисалы, ресурстар гана)
Же болбосо, негизинен javadoc генерациялоону каалабайсыз, андан кийин жардам берүү үчүн 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>
<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-плагин
Конфигурация:
<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>Эгер сизде көп модулдуу долбоор болсо жана репозиторийге белгилүү бир модулду жүктөөнүн кереги жок болсо, анда бул модулдун pom.xml файлына кошуу керек. nexus-staging-maven-plugin желек менен skipNexusStagingDeployMojo
<build>
<plugins>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<configuration>
<skipNexusStagingDeployMojo>true</skipNexusStagingDeployMojo>
</configuration>
</plugin>
</plugins>
</build>Снапшот/релиз версиялары жүктөлгөндөн кийин жеткиликтүү
<repositories>
<repository>
<id>SonatypeNexus</id>
<url>https://oss.sonatype.org/content/groups/staging/</url>
<!-- Не надо указывать флаги snapshot/release для репозитория -->
</repository>
</repositories>Дагы плюс
- Nexus репозиторий менен иштөө үчүн максаттардын абдан бай тизмеси (
mvn help:describe -Dplugin=org.sonatype.plugins:nexus-staging-maven-plugin). - Maven борборунда жүктөө мүмкүнчүлүгүн автоматтык түрдө текшерүү
жыйынтык
SNAPSHOT версиясын жарыялоо
Долбоорду куруп жатканда, SNAPSHOT версиясын Nexus'ка жүктөө үчүн тапшырманы кол менен баштоого болот
Бул тапшырма ишке киргизилгенде, жайылтуу долбоорундагы тиешелүү тапшырма ишке кирет ().
кесилген журнал
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] ------------------------------------------------------------------------Натыйжада, Nexus версия жүктөлөт .
Бардык көз ирмемдик версияларды сайттагы репозиторийден алып салса болот сиздин эсебиңиздин астында.
Чыгарылган версиясын жарыялоо
Тег коюлганда, жайылтуу долбоорундагы тиешелүү тапшырма релиз версиясын Nexus'ка жүктөө үчүн автоматтык түрдө иштетилет ().
Эң жакшы жери, жабуу релизинин автоматтык түрдө 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] ------------------------------------------------------------------------Ал эми бир нерсе туура эмес болсо, анда тапшырма аткарылбай калат
[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] ------------------------------------------------------------------------Жыйынтыгында бизде бир гана тандоо калды. Же бул версияны жок кылыңыз же жарыялаңыз.
Чыгарылгандан кийин, бир нече убакыт өткөндөн кийин, артефакттар кирет
темадан тышкары
Мавен башка коомдук репозиторийлерди индекстегени мен үчүн ачылыш болду.
Мен robots.txt файлын жүктөшүм керек болчу, анткени ал менин эски репозиторийимди индекстеген.
жыйынтыктоо
Бизде эмне бар
- Артефакттарды ар кандай өнүктүрүү тилдеринин коомдук репозиторийлерине жүктөө үчүн бир нече CI тапшырмаларын ишке ашыра турган өзүнчө жайылтуу долбоору.
- Жайгаштыруу долбоору сырттан кийлигишүүдөн обочолонгон жана аны Ээси жана Тейлөөчү ролдору бар колдонуучулар гана өзгөртүшү мүмкүн.
- Жайгаштыруу тапшырмаларын гана иштетүү үчүн "ысык" кэши бар өзүнчө Specific Runner.
- Коомдук репозиторийде көз ирмемдик сүрөт/релиз версияларын жарыялоо.
- Чыгарылган версияны автоматтык түрдө maven Centralда жарыялоого даярдыгын текшерүү.
- maven борборунда "чийки" версияларды автоматтык түрдө жарыялоодон коргоо.
- Снапшот версияларын "басканда" түзүңүз жана жарыялаңыз.
- Снапшот/релиз версияларын алуу үчүн бирдиктүү репозиторий.
- Java долбоорун куруу / сыноо / жарыялоо үчүн жалпы түтүк.
GitLab CI орнотуу биринчи караганда көрүнгөндөй татаал тема эмес. CIди ачкычка тапшыруу боюнча бир нече жолу орнотуу жетиштүү, эми сиз бул маселеде ышкыбоздуктан алыссыз. Андан тышкары, GitLab документтери өтө ашыкча. Биринчи кадамды жасоодон коркпоңуз. Жол басып бара жаткан адамдын тепкичтеринин астында пайда болот (ким айтканы эсимде жок :)
Пикириңизге кубанычта болом.
Кийинки макалада, мен сизге GitLab CIди кантип орнотууну көрсөтөм, эгерде сизде бир гана shell runner болсо, интеграциялык тест тапшырмаларын атаандаштыкта (докер-композит менен иштөөчү тест кызматтары) иштетүү.
Source: www.habr.com