Artikel ini ditujukan untuk pengembang java yang perlu mempublikasikan produk mereka dengan cepat ke repositori pusat sonatype dan/atau maven menggunakan GitLab. Pada artikel ini, saya akan berbicara tentang menyiapkan gitlab-runner, gitlab-ci dan maven-plugin untuk mengatasi masalah ini.
Prasyarat:
- Penyimpanan kunci mvn dan GPG yang aman.
- Amankan pelaksanaan tugas CI publik.
- Mengunggah artefak (rilis/snapshot) ke repositori publik.
- Pemeriksaan otomatis versi rilis untuk publikasi di pusat maven.
- Solusi umum untuk mengunggah artefak ke repositori untuk beberapa proyek.
- Kesederhanaan dan kemudahan penggunaan.
kadar
Informasi umum
- Penjelasan rinci tentang mekanisme penerbitan artefak ke Maven Central melalui Layanan Hosting Repositori Sonatype OSS sudah dijelaskan di pengguna , jadi saya akan merujuk artikel ini di tempat yang tepat.
- Pra-registrasi di dan mulai tiket untuk membuka repositori (untuk lebih jelasnya, baca bagian ). Setelah membuka repositori, pasangan login/kata sandi JIRA (selanjutnya disebut akun Sonatype) akan digunakan untuk mengunggah artefak ke nexus Sonatype.
- Selanjutnya, proses menghasilkan kunci GPG dijelaskan dengan sangat kering. Lihat bagian untuk lebih jelasnya.
- Jika Anda menggunakan konsol Linux untuk menghasilkan kunci GPG (gnupg/gnupg2), maka Anda perlu menginstal untuk menghasilkan entropi. Jika tidak, pembuatan kunci bisa memakan waktu sangat lama.
- Layanan Penyimpanan publik Kunci GPG
Menyiapkan proyek penerapan di GitLab
- Pertama-tama, Anda perlu membuat dan mengonfigurasi proyek di mana alur untuk penerapan artefak akan disimpan. Saya menyebut proyek saya sederhana dan tidak rumit -
- Setelah membuat repositori, Anda perlu membatasi akses untuk mengubah repositori.
Buka proyek -> Pengaturan -> Repositori -> Cabang yang Dilindungi. Kami menghapus semua aturan dan menambahkan satu aturan dengan Wildcard * dengan hak untuk mendorong dan menggabungkan hanya untuk pengguna dengan peran Pengelola. Aturan ini akan berlaku untuk semua pengguna proyek ini dan grup tempat proyek ini berada.
- Jika ada beberapa pengelola, maka solusi terbaik adalah membatasi akses ke proyek secara prinsip.
Buka proyek -> Pengaturan -> Umum -> Visibilitas, fitur proyek, izin dan atur visibilitas Proyek ke Swasta.
Saya memiliki proyek dalam akses publik, karena saya menggunakan GitLab Runner saya sendiri dan hanya saya yang memiliki akses untuk mengubah repositori. Sebenarnya bukan kepentingan saya untuk menampilkan informasi pribadi di log saluran pipa publik. - Memperketat aturan untuk mengubah repositori
Buka proyek -> Pengaturan -> Repositori -> Aturan Dorong dan atur tandanya Pembatasan komitter, Periksa apakah penulis adalah pengguna GitLab. Saya juga merekomendasikan pengaturan , dan setel tanda Tolak komit yang tidak ditandatangani. - Selanjutnya, Anda perlu mengonfigurasi pemicu untuk menjalankan tugas
Buka proyek -> Pengaturan -> CI / CD -> Pemicu saluran dan buat token pemicu baru
Token ini dapat langsung ditambahkan ke konfigurasi umum variabel untuk sekelompok proyek.
Buka grup -> Pengaturan -> CI/CD -> Variabel dan tambahkan variabelDEPLOY_TOKENdengan trigger-token di nilainya.
Pelari GitLab
Bagian ini menjelaskan konfigurasi untuk menjalankan tugas pada penerapan menggunakan runner asli (Khusus) dan publik (Bersama).
Pelari Tertentu
Saya menggunakan pelari saya sendiri, karena pertama-tama nyaman, cepat, dan murah.
Untuk runner saya merekomendasikan Linux VDS dengan 1 CPU, 2 GB RAM, 20 GB HDD. Harga penerbitan ~ 3000₽ per tahun.
Pelari saya
Untuk runner saya mengambil CPU VDS 4, RAM 4 GB, SSD 50 GB. Harganya ~11000₽ dan tidak pernah menyesalinya.
Saya memiliki total 7 mesin. 5 di aruba dan 2 di ihor.
Jadi, kita punya pelari. Sekarang kita akan mengaturnya.
Kami masuk ke mesin melalui SSH dan menginstal Java, git, maven, gnupg2.
Menginstal pelari gitlab
- Buat grup baru
runnersudo groupadd runner - Buat direktori untuk cache maven dan tetapkan hak grup
runner
Anda dapat melewati langkah ini jika Anda tidak berencana menjalankan beberapa pelari di mesin yang sama.mkdir -p /usr/cache/.m2/repository chown -R :runner /usr/cache chmod -R 770 /usr/cache - Buat pengguna
gitlab-deployerdan tambahkan ke gruprunneruseradd -m -d /home/gitlab-deployer gitlab-deployer usermod -a -G runner gitlab-deployer - Tambahkan ke berkas
/etc/ssh/sshd_configbaris berikutnyaAllowUsers root@* [email protected] - Menyalakan ulang
sshdsystemctl restart sshd - Tetapkan kata sandi untuk pengguna
gitlab-deployer(ini bisa sederhana, karena ada batasan untuk localhost)passwd gitlab-deployer - Instal 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 - Buka gitlab.com -> deploy-project -> Pengaturan -> CI/CD -> Pelari -> Pelari Tertentu dan salin token pendaftaran
Layar
- Mendaftarkan pelari
gitlab-runner register --config /etc/gitlab-runner/gitlab-deployer-config.toml
proses
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!- Periksa apakah pelari sudah terdaftar. Buka gitlab.com -> deploy-project -> Pengaturan -> CI/CD -> Pelari -> Pelari Tertentu -> Pelari yang diaktifkan untuk proyek ini
Layar
- Menambahkan terpisah layanan
/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 - Kami memulai layanan.
systemctl enable gitlab-deployer.service systemctl start gitlab-deployer.service systemctl status gitlab-deployer.service - Periksa apakah pelari sedang berlari.
Contoh
Pembuatan kunci GPG
-
Dari mesin yang sama kita melalui ssh di bawah pengguna
gitlab-deployer(ini penting untuk pembuatan kunci GPG)ssh [email protected] -
Kami menghasilkan kunci dengan menjawab pertanyaan. Saya menggunakan nama dan email saya sendiri.
Pastikan untuk menentukan kata sandi untuk kunci tersebut. Artefak akan ditandatangani dengan kunci ini.gpg --gen-key -
Memeriksa
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 -
Mengunggah kunci publik kita ke server kunci
gpg --keyserver keys.gnupg.net --send-key 00000000 gpg: sending key 00000000 to hkp server keys.gnupg.net
Pengaturan pakar
- Kami berada di bawah pengguna
gitlab-deployersu gitlab-deployer - Buat direktori pakar gudang dan link dengan cache (jangan salah)
Langkah ini dapat dilewati jika Anda tidak berencana menjalankan beberapa pelari pada mesin yang sama.mkdir -p ~/.m2/repository ln -s /usr/cache/.m2/repository /home/gitlab-deployer/.m2/repository - Buat kunci utama
mvn --encrypt-master-password password {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=} - Buat file ~/.m2/settings-security.xml
<settingsSecurity> <master>{hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}</master> </settingsSecurity> - Mengenkripsi kata sandi dari akun Sonatype
mvn --encrypt-password SONATYPE_PASSWORD {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J} - Buat file ~/.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>
di mana,
GPG_SECRET_KEY_PASSPHRASE - kata sandi kunci GPG
SONATYPE_USERNAME - login akun sonatype
Ini menyelesaikan pengaturan pelari, Anda dapat melanjutkan ke bagian tersebut
Pelari Bersama
Pembuatan kunci GPG
-
Pertama-tama, Anda perlu membuat kunci GPG. Untuk melakukan ini, instal gnupg.
yum install -y gnupg -
Kami menghasilkan kunci dengan menjawab pertanyaan. Saya menggunakan nama dan email saya sendiri. Pastikan untuk menentukan kata sandi untuk kunci tersebut.
gpg --gen-key -
Ambil informasi penting
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] -
Mengunggah kunci publik kita ke server kunci
gpg --keyserver keys.gnupg.net --send-key 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 gpg: sending key 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 to hkp server keys.gnupg.net -
Mendapatkan kunci pribadi
gpg --export-secret-keys --armor 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 -----BEGIN PGP PRIVATE KEY BLOCK----- lQWGBFzAqp8BDADN41CPwJ/gQwiKEbyA902DKw/WSB1AvZQvV/ZFV77xGeG4K7k5 ... =2Wd2 -----END PGP PRIVATE KEY BLOCK----- -
Buka pengaturan proyek -> Pengaturan -> CI / CD -> Variabel dan simpan kunci pribadi dalam sebuah variabel
GPG_SECRET_KEY
Pengaturan pakar
- Buat kunci utama
mvn --encrypt-master-password password {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=} - Buka pengaturan proyek -> Pengaturan -> CI / CD -> Variabel dan simpan dalam variabel
SETTINGS_SECURITY_XMLbaris berikut:<settingsSecurity> <master>{hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}</master> </settingsSecurity> - Mengenkripsi kata sandi dari akun Sonatype
mvn --encrypt-password SONATYPE_PASSWORD {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J} - Buka pengaturan proyek -> Pengaturan -> CI / CD -> Variabel dan simpan dalam variabel
SETTINGS_XMLbaris berikut:<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>
di mana,
GPG_SECRET_KEY_PASSPHRASE - kata sandi kunci GPG
SONATYPE_USERNAME - login akun sonatype
Terapkan gambar buruh pelabuhan
-
Kami membuat Dockerfile yang cukup sederhana untuk menjalankan tugas yang diterapkan dengan versi Java yang diinginkan. Di bawah ini adalah contoh untuk 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/ -
Membangun wadah untuk proyek Anda
docker build -t registry.gitlab.com/group/deploy . -
Kami mengautentikasi dan memuat kontainer ke dalam registri.
docker login -u USER -p PASSWORD registry.gitlab.com docker push registry.gitlab.com/group/deploy
GitLab CI
Terapkan proyek
Tambahkan file .gitlab-ci.yml ke root proyek penerapan
Skrip ini menyajikan dua tugas penerapan yang saling eksklusif. Pelari Tertentu atau Pelari Bersama.
.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
proyek Jawa
Dalam proyek Java yang seharusnya diunggah ke repositori publik, Anda perlu menambahkan 2 langkah untuk mengunduh versi Rilis dan 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}Dalam solusi ini, saya melangkah lebih jauh dan memutuskan untuk menggunakan satu template CI untuk proyek Java.
Lebih jelasnya
Saya membuat proyek terpisah di mana dia menempatkan template CI untuk proyek Java .
umum.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
Hasilnya, dalam proyek java itu sendiri, .gitlab-ci.yml terlihat sangat kompak dan tidak bertele-tele
.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
konfigurasi pom.xml
Topik ini dijelaskan dengan sangat rinci. в , jadi saya akan menjelaskan beberapa nuansa penggunaan plugin. Saya juga akan menjelaskan betapa mudah dan alaminya Anda dapat menggunakannya nexus-staging-maven-pluginjika Anda tidak ingin atau tidak dapat menggunakan org.sonatype.oss:oss-parent sebagai induk proyek Anda.
maven-install-plugin
Menginstal modul di repositori lokal.
Sangat berguna untuk verifikasi solusi lokal di proyek lain, serta 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
Menghasilkan javadoc untuk proyek tersebut.
<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>Jika Anda memiliki modul yang tidak mengandung java (misalnya hanya sumber daya)
Atau Anda tidak ingin membuat javadoc pada prinsipnya, maka bantulah 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
Konfigurasi:
<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>Jika Anda memiliki proyek multi-modul, dan Anda tidak perlu mengunggah modul tertentu ke repositori, maka Anda perlu menambahkan pom.xml modul ini nexus-staging-maven-plugin dengan bendera skipNexusStagingDeployMojo
<build>
<plugins>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<configuration>
<skipNexusStagingDeployMojo>true</skipNexusStagingDeployMojo>
</configuration>
</plugin>
</plugins>
</build>Setelah mengunggah versi snapshot/rilis tersedia
<repositories>
<repository>
<id>SonatypeNexus</id>
<url>https://oss.sonatype.org/content/groups/staging/</url>
<!-- Не надо указывать флаги snapshot/release для репозитория -->
</repository>
</repositories>Lebih banyak plus
- Daftar target yang sangat kaya untuk bekerja dengan repositori nexus (
mvn help:describe -Dplugin=org.sonatype.plugins:nexus-staging-maven-plugin). - Rilis otomatis memeriksa kemampuan pengunduhan di pusat maven
Hasil
Menerbitkan Versi SNAPSHOT
Saat membangun sebuah proyek, dimungkinkan untuk memulai tugas secara manual untuk mengunduh versi SNAPSHOT ke nexus
Ketika tugas ini diluncurkan, tugas terkait dalam proyek penerapan dipicu ().
log yang dipotong
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] ------------------------------------------------------------------------Hasilnya, versi Nexus dimuat .
Semua versi snapshot dapat dihapus dari repositori di situs di bawah akun Anda.
Publikasi versi rilis
Ketika tag disetel, tugas terkait dalam proyek penerapan secara otomatis dipicu untuk mengunggah versi rilis ke nexus ().
Bagian terbaiknya adalah rilis jarak dekat terpicu secara otomatis di 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] ------------------------------------------------------------------------Dan jika terjadi kesalahan, maka tugas tersebut akan gagal
[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] ------------------------------------------------------------------------Akibatnya, kita hanya punya satu pilihan. Atau hapus versi ini atau publikasikan.
Setelah rilis, setelah beberapa waktu, artefak akan masuk
diluar topic
Merupakan wahyu bagi saya bahwa pakar mengindeks repositori publik lainnya.
Saya harus mengunggah robots.txt karena mengindeks repositori lama saya.
Kesimpulan
Apa yang kita miliki
- Proyek penerapan terpisah di mana Anda dapat mengimplementasikan beberapa tugas CI untuk mengunggah artefak ke repositori publik untuk berbagai bahasa pengembangan.
- Proyek penerapan diisolasi dari gangguan luar dan hanya dapat dimodifikasi oleh pengguna dengan peran Pemilik dan Pengelola.
- Pelari Spesifik terpisah dengan cache "panas" untuk menjalankan tugas penerapan saja.
- Publikasi versi snapshot/rilis di repositori publik.
- Pemeriksaan otomatis versi rilis untuk kesiapan publikasi di pusat maven.
- Perlindungan terhadap publikasi otomatis versi "mentah" di maven central.
- Buat dan publikasikan versi snapshot “saat diklik”.
- Repositori tunggal untuk mendapatkan versi snapshot/rilis.
- Pipa umum untuk membangun/menguji/menerbitkan proyek Java.
Menyiapkan GitLab CI bukanlah topik yang rumit seperti yang terlihat pada pandangan pertama. Cukup dengan menyiapkan CI secara turnkey beberapa kali, dan sekarang Anda jauh dari amatir dalam hal ini. Selain itu, dokumentasi GitLab sangat mubazir. Jangan takut untuk mengambil langkah pertama. Jalan muncul di bawah langkah orang yang berjalan (saya tidak ingat siapa yang mengatakannya :)
Saya akan dengan senang hati memberikan masukan.
Pada artikel berikutnya, saya akan menunjukkan cara menyiapkan GitLab CI untuk menjalankan tugas pengujian integrasi secara kompetitif (menjalankan layanan pengujian dengan docker-compose) jika Anda hanya memiliki satu shell runner.
Sumber: www.habr.com