ProHoster > Blog > Rêveberî > Sazkirina GitLab CI ji bo barkirina projeyek java li maven navendî
Sazkirina GitLab CI ji bo barkirina projeyek java li maven navendî
Ev gotar ji bo pêşdebirên java-yê ku hewcedariya wan heye ku zû zû hilberên xwe di depoyên navendî yên sonatype û/an maven de bi karanîna GitLab biweşînin. Di vê gotarê de ez ê li ser sazkirina gitlab-runner, gitlab-ci û maven-plugin ji bo çareserkirina vê pirsgirêkê biaxivim.
Reert û merc:
Hilanîna ewle ya bişkokên mvn û GPG.
Pêkanîna ewledar a peywirên CI-ya giştî.
Barkirina berheman (berdan / dîmen) li depoyên giştî.
Kontrolkirina otomatîkî ya guhertoyên berdanê ji bo weşana li navenda maven.
Çareseriyek gelemperî ji bo barkirina huneran li depoyek ji bo pir projeyan.
Danasînek berfireh a mekanîzmaya weşandina huneran li Maven Central bi navgîniya Karûbarê Mêvandariya Depoya Sonatype OSS jixwe di vê gotarê bikaranîvan Googplex, ji ber vê yekê ez ê li cîhên rast behsa vê gotarê bikim.
Ji bo pêş-qeyd bikin Sonatype JIRA û bilêtek vekin da ku depoyê vekin (beşê ji bo bêtir agahdarî bixwînin Bilêtek li ser Sonatype JIRA biafirînin). Piştî vekirina depoyê, cotê têketin/şîfreya ji JIRA (li vir wekî hesabê Sonatype tê binavkirin) dê ji bo barkirina huneran li Sonatype nexus were bikar anîn.
Ger hûn konsolê Linux-ê bikar bînin ku mifteyek GPG (gnupg/gnupg2) çêbikin, wê hingê hûn hewce ne ku saz bikin rng-tools ji bo afirandina entropiyê. Wekî din, nifşa sereke dibe ku demek pir dirêj bigire.
Berî her tiştî, hûn hewce ne ku projeyek biafirînin û mîheng bikin ku tê de lûle ji bo danîna huneran were hilanîn. Min navê projeya xwe bi hêsanî û ne tevlihev kir - bicîh bikin
Piştî afirandina depoyê, hûn hewce ne ku gihîştinê sînordar bikin da ku depoyê biguhezînin.
Biçe projeyê -> Mîheng -> Depo -> Şaxên Parastî. Em hemî qaîdeyan jê dikin û bi Wildcard * re qaîdeyek yekane lê zêde dikin ku tenê ji bo bikarhênerên bi rola Maintainer re heye ku bişopîne û bike yek. Ev qayde dê ji bo hemî bikarhênerên vê projeyê û koma ku ev proje tê de ye bixebite.
Ger çend parêzger hebin, wê hingê çareseriya çêtirîn dê di prensîbê de sînorkirina gihîştina projeyê be.
Herin proje -> Mîheng -> Giştî -> Dîtin, taybetmendiyên projeyê, destûr û dîtina projeyê bicîh bikin. taybet.
Projeyek min a gelemperî heye, ji ber ku ez GitLab Runner-a xwe bikar tînim û tenê ez gihîştim guheztina depoyê. Welê, bi rastî, ne di berjewendiya min de ye ku agahdariya taybet di têketinên boriyên gelemperî de nîşan bidim.
Zêdekirina qaîdeyên ji bo guhertina depoyê
Herin projeyê -> Mîhengan -> Depoyê -> Rêbazên Pushê û sînorkirina Committer saz bikin, Kontrol bikin ka nivîskar alên bikarhênerek GitLab e. Ez jî sazkirinê pêşniyar dikim îmze kirin, û ala redkirina bêîmzeyan danîne.
Dûv re hûn hewce ne ku tetikek ji bo destpêkirina karan mîheng bikin
Herin projeyê -> Mîhengan -> CI / CD -> Pipeline dişoxilîne û nîşanek nû ya tetikê biafirîne.
Ev nîşanek yekser dikare li veavakirina giştî ya guhêrbaran ji bo komek projeyan were zêdekirin.
Biçe komê -> Settings -> CI / CD -> Guherbar û guhêrbarek lê zêde bike DEPLOY_TOKEN bi nirxa tetikê-token.
Ev beş veavakirina ji bo xebitandina peywirên li ser danînê bi karanîna geroka weya xweya (Taybetî) û gelemperî (Parhevkirî) vedibêje.
Runner taybetî
Ez bezvanên xwe bikar tînim ji ber ku, berî her tiştî, ew hêsan, bilez û erzan e.
Ji bo bezê, ez Linux VDS-ê bi 1 CPU, 2 GB RAM, 20 GB HDD pêşniyar dikim. Buhayê pirsgirêkê salê ~ 3000₽ e.
Runerê min
Ji bo runner min VDS 4 CPU, 4 GB RAM, 50 GB SSD girt. Mesrefa ~ 11000 ₽ û qet jê poşman nebû.
Bi tevahî 7 makîneyên min hene. 5 li ser aruba û 2 li ser ihor.
Ji ber vê yekê me revînek heye. Niha em ê wê mîheng bikin.
Em bi rêya SSH diçin makîneyê û java, git, maven, gnupg2 saz dikin.
Ji bo cache maven pelrêçek biafirînin û destûrên komê bidin runner
Heke hûn ne plan dikin ku li ser yek makîneyek çend bazdan bimeşînin hûn dikarin vê xalê berdin.
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!
Em kontrol dikin ku bezê qeydkirî ye. Biçe ser malpera gitlab.com -> deploy-project -> Mîheng -> CI/CD -> Runners -> Runnersên Taybet -> Runners ji bo vê projeyê çalak kirin
Parêzî
Zêde bikin veqetandin xizmeta /etc/systemd/system/gitlab-deployer.service
Em bi bersiva pirsan mifteyek çêdikin. Min navê xwe û e-nameya xwe bikar anî.
Bawer bikin ku şîfreya mifteyê diyar bikin. Bi vê mifteyê dê berhem bên îmzekirin.
gpg --gen-key
Kontrolkirin
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
Mifteya meya giştî li servera mifteyê barkirin
gpg --keyserver keys.gnupg.net --send-key 00000000
gpg: sending key 00000000 to hkp server keys.gnupg.net
Peldanka maven çêbikin pirtûkxaneyê û bi kaşê ve girêdin (şaşiyê nekin)
Heke hûn ne plan dikin ku li ser yek makîneyek çend bazdan bimeşînin hûn dikarin vê xalê berdin.
Pelê .gitlab-ci.yml li koka projeya vesazkirinê zêde bikin
Skrîpta du peywirên veqetandinê yên ji hev veqetandî pêşkêşî dike. Bi rêzê ve Runner an Parvekirî ya Taybet.
.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
Ev mijar bi berfirehî tê vegotin. Googplex в Sazkirina maven-ê ku bixweber îmze bike û huneran li depoyên wênekêş û sehneyê bar bike, ji ber vê yekê ez ê hin hûrgelên karanîna pêvekan diyar bikim. Ez ê jî diyar bikim ka hûn dikarin çiqas hêsan û rehet bikar bînin nexus-staging-maven-pluginheke hûn nexwazin an nekarin org.sonatype.oss:oss-parent wekî dêûbav ji bo projeya xwe bikar bînin.
maven-install-plugin
Modulan di depoya herêmî de saz dike.
Ji bo verastkirina herêmî ya çareseriyên di projeyên din de, û her weha jimareyek kontrolê pir bikêr e.
<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>
<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>
Ger modulek we heye ku java nahewîne (mînakî tenê çavkaniyan)
An jî hûn naxwazin di prensîbê de javadoc biafirînin, wê hingê bibin alîkar maven-jar-plugin
Ger projeyek weya pir-modûl hebe û hûn ne hewce ne ku modulek taybetî li depoyê bar bikin, wê hingê pêdivî ye ku hûn lê zêde bikin nexus-staging-maven-plugin bi ala skipNexusStagingDeployMojo
Piştî dakêşandinê, guhertoyên snapshot / berdanê tê de hene depoyên sehneyê
<repositories>
<repository>
<id>SonatypeNexus</id>
<url>https://oss.sonatype.org/content/groups/staging/</url>
<!-- Не надо указывать флаги snapshot/release для репозитория -->
</repository>
</repositories>
Zêdetir pluss
Lîsteyek pir dewlemend a armancên ji bo xebata bi depoya nexus (mvn help:describe -Dplugin=org.sonatype.plugins:nexus-staging-maven-plugin).
Kontrola berdana otomatîkî ji bo barkirina maven navendî
Dema ku etîketek tê saz kirin, di projeya bicîhkirinê de peywira têkildar bixweber tê dest pê kirin da ku guhertoya berdanê ji nexus re dakêşe (nimûne).
Beşa çêtirîn ev e ku serbestberdana nêzîk bixweber di nexusê de tê destpêkirin.
[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] ------------------------------------------------------------------------
Û heke tiştek xelet derkeve, dê peywir bê guman têk bibe
[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] ------------------------------------------------------------------------
Di encamê de, em tenê bi yek bijartî re dimînin. An vê guhertoyê jêbikin an jî biweşînin.
Piştî serbestberdanê, piştî demek şûnda dê huner tê de bin
derî behsê
Ji bo min vedîtinek bû ku maven depoyên giştî yên din nîşan dide.
Diviya bû ku ez robots.txt lê zêde bikim ji ber ku ew depoya min a kevn îndeks kir.
Projeyek veqetandî ya cihê ku tê de hûn dikarin gelek peywirên CI-yê ji bo barkirina huneran li depoyên gelemperî ji bo zimanên pêşkeftinê yên cihêreng bicîh bikin.
Projeya Deploy ji destwerdana derveyî veqetandî ye û tenê ji hêla bikarhênerên bi rola Xwedî û Xwedîder ve dikare were guheztin.
Runnerek Taybet a veqetandî bi kaşek "germ" ve ku tenê peywiran dimeşîne.
Di depoyek giştî de guhertoyên snapshot/berdan weşandin.
Kontrolkirina otomatîkî ya guhertoya berdanê ji bo amadebûna ji bo weşanê li navenda maven.
Parastina li dijî weşana otomatîkî ya guhertoyên "raw" li navenda maven.
Guhertoyên wêneyê "li ser klîk" ava bikin û biweşînin.
Depoyek yekane ya ji bo bidestxistina guhertoyên wênekêş / berdanê.
Rêzeya gelemperî ji bo avakirina / ceribandin / weşandina projeyek java.
Sazkirina GitLab CI ne mijarek tevlihev e ku di nihêrîna pêşîn de xuya dike. Bes e ku meriv çend caran CI-ê li ser bingehek kilît saz bike, û naha hûn di vê mijarê de ji amatorek dûr in. Wekî din, belgeyên GitLab pir zêde ne. Ji avêtina gava yekem netirsin. Rê di bin gavên kesê ku dimeşe xuya dike (Kê gotiye nayê bîra min:)
Ez ê kêfxweş bibim ku bersivê werbigirim.
Di gotara din de ez ê bipeyivim ka meriv çawa GitLab CI-ê çawa mîheng dike da ku peywirên bi ceribandinên entegrasyonê re bi pêşbazî bimeşîne (xebata karûbarên di bin ceribandinê de bi karanîna docker-compose) heke we tenê yek gerokek şêlê hebe.