บทความนี้มีไว้สำหรับนักพัฒนา Java ที่ต้องการเผยแพร่ผลิตภัณฑ์ของตนไปยัง sonatype และ/หรือ Maven Central Repositories อย่างรวดเร็วโดยใช้ GitLab ในบทความนี้ ผมจะพูดถึงการตั้งค่า gitlab-runner, gitlab-ci และ maven-plugin เพื่อแก้ไขปัญหานี้
ข้อกำหนดเบื้องต้น:
- การจัดเก็บคีย์ mvn และ GPG อย่างปลอดภัย
- ดำเนินงาน CI สาธารณะอย่างปลอดภัย
- การอัปโหลดสิ่งประดิษฐ์ (ปล่อย/สแนปชอต) ไปยังที่เก็บข้อมูลสาธารณะ
- ตรวจสอบเวอร์ชันเผยแพร่โดยอัตโนมัติสำหรับการเผยแพร่ใน Maven Central
- โซลูชันทั่วไปสำหรับการอัปโหลดอาร์ติแฟกต์ไปยังพื้นที่เก็บข้อมูลสำหรับหลายโปรเจ็กต์
- ความเรียบง่ายและใช้งานง่าย
Содержание
ข้อมูลทั่วไป การตั้งค่าโครงการปรับใช้ใน GitLab นักวิ่ง GitLab GitLab CI การกำหนดค่า pom.xml ผล ข้อสรุป
ข้อมูลทั่วไป
- คำอธิบายโดยละเอียดของกลไกในการเผยแพร่อาร์ติแฟกต์ไปยัง Maven Central ผ่าน Sonatype OSS Repository Hosting Service ได้อธิบายไว้แล้วใน
บทความนี้ ผู้ใช้กูกอลเพลกซ์ ดังนั้นฉันจะอ้างอิงบทความนี้ในตำแหน่งที่ถูกต้อง - ลงทะเบียนล่วงหน้าได้ที่
โซนาไทป์ จิระ และเริ่มตั๋วเพื่อเปิดพื้นที่เก็บข้อมูล (สำหรับรายละเอียดเพิ่มเติม อ่านหัวข้อสร้างตั๋ว Sonatype JIRA ). หลังจากเปิดพื้นที่เก็บข้อมูล คู่ล็อกอิน/รหัสผ่าน JIRA (ต่อไปนี้จะเรียกว่าบัญชี Sonatype) จะถูกนำมาใช้เพื่ออัปโหลดอาร์ติแฟกต์ไปยัง Sonatype Nexus - นอกจากนี้ กระบวนการสร้างคีย์ GPG มีการอธิบายไว้อย่างแห้งแล้งมาก ดูส่วนสำหรับรายละเอียดเพิ่มเติม
การกำหนดค่า GnuPG เพื่อลงนามสิ่งประดิษฐ์ - หากคุณใช้คอนโซล Linux เพื่อสร้างคีย์ GPG (gnupg/gnupg2) คุณจะต้องติดตั้ง
RNG เครื่องมือ เพื่อสร้างเอนโทรปี มิฉะนั้น การสร้างคีย์อาจใช้เวลานานมาก - บริการจัดเก็บข้อมูล สาธารณะ คีย์จีพีจี
http://keys.gnupg.net http://pool.sks-keyservers.net http://keyserver.ubuntu.com
การตั้งค่าโครงการปรับใช้ใน GitLab
- ก่อนอื่น คุณต้องสร้างและกำหนดค่าโปรเจ็กต์ที่จะจัดเก็บไปป์ไลน์สำหรับการปรับใช้อาร์ติแฟกต์ ฉันเรียกโครงการของฉันอย่างเรียบง่ายและไม่ซับซ้อน -
ปรับใช้ - หลังจากสร้างที่เก็บแล้ว คุณต้องจำกัดการเข้าถึงเพื่อเปลี่ยนที่เก็บ
ไปที่โครงการ -> การตั้งค่า -> พื้นที่เก็บข้อมูล -> สาขาที่ได้รับการป้องกัน เราลบกฎทั้งหมดและเพิ่มกฎเดียวด้วย Wildcard * โดยมีสิทธิ์ในการพุชและรวมสำหรับผู้ใช้ที่มีบทบาทผู้ดูแลเท่านั้น กฎนี้จะใช้ได้กับผู้ใช้ทั้งหมดของทั้งโปรเจ็กต์นี้และกลุ่มที่เป็นเจ้าของโปรเจ็กต์นี้
- หากมีผู้ดูแลหลายคน ทางออกที่ดีที่สุดคือการจำกัดการเข้าถึงโปรเจ็กต์ตามหลักการ
ไปที่โปรเจ็กต์ -> การตั้งค่า -> ทั่วไป -> การมองเห็น คุณสมบัติโปรเจ็กต์ การอนุญาต และตั้งค่าการมองเห็นโปรเจ็กต์เป็น ส่วนตัว.
ฉันมีโปรเจ็กต์ที่เข้าถึงได้แบบสาธารณะ เนื่องจากฉันใช้ GitLab Runner ของตัวเอง และมีเพียงฉันเท่านั้นที่มีสิทธิ์เข้าถึงเพื่อแก้ไขพื้นที่เก็บข้อมูล ที่จริงแล้วฉันไม่สนใจที่จะแสดงข้อมูลส่วนตัวในบันทึกไปป์ไลน์สาธารณะ - กระชับกฎเกณฑ์ในการเปลี่ยนพื้นที่เก็บข้อมูล
ไปที่โครงการ -> การตั้งค่า -> พื้นที่เก็บข้อมูล -> กฎการพุช และตั้งค่าสถานะข้อ จำกัด ผู้ส่ง ตรวจสอบว่าผู้เขียนเป็นผู้ใช้ GitLab หรือไม่ ฉันยังแนะนำการตั้งค่าลงนามผูกพัน และตั้งค่าแฟล็กปฏิเสธการคอมมิตที่ไม่ได้ลงนาม - ถัดไป คุณต้องกำหนดค่าทริกเกอร์เพื่อรันงาน
ไปที่โครงการ -> การตั้งค่า -> CI / CD -> ทริกเกอร์ไปป์ไลน์และสร้างทริกเกอร์โทเค็นใหม่
โทเค็นนี้สามารถเพิ่มลงในการกำหนดค่าทั่วไปของตัวแปรสำหรับกลุ่มโปรเจ็กต์ได้ทันที
ไปที่กลุ่ม -> การตั้งค่า -> CI / CD -> ตัวแปร และเพิ่มตัวแปรDEPLOY_TOKEN
โดยมีทริกเกอร์โทเค็นอยู่ในค่า
นักวิ่ง GitLab
ส่วนนี้อธิบายการกำหนดค่าสำหรับการรันงานในการปรับใช้โดยใช้รันเนทีฟ (เฉพาะ) และรันเนอร์สาธารณะ (แชร์)
นักวิ่งเฉพาะ
ฉันใช้นักวิ่งของตัวเองเพราะอย่างแรกเลยคือสะดวก รวดเร็ว และราคาถูก
สำหรับนักวิ่งผมขอแนะนำ Linux VDS ที่มี 1 CPU, 2 GB RAM, 20 GB HDD ราคาออก ~ 3000₽ ต่อปี
นักวิ่งของฉัน
สำหรับนักวิ่งฉันใช้ CPU VDS 4, RAM 4 GB, SSD 50 GB ราคาประมาณ 11000₽ และไม่เคยเสียใจเลย
ผมมีทั้งหมด 7 เครื่อง 5 บน aruba และ 2 บน ihor
ดังนั้นเราจึงมีนักวิ่ง ตอนนี้เราจะตั้งค่ามัน
เราไปที่เครื่องผ่าน SSH และติดตั้ง java, git, maven, gnupg2
การติดตั้ง gitlab runner
- สร้างกลุ่มใหม่
runner
sudo groupadd runner
- สร้างไดเร็กทอรีสำหรับแคช Maven และกำหนดสิทธิ์ของกลุ่ม
runner
คุณสามารถข้ามขั้นตอนนี้ได้หากคุณไม่ได้วางแผนที่จะวิ่งหลายวิ่งบนเครื่องเดียวกันmkdir -p /usr/cache/.m2/repository chown -R :runner /usr/cache chmod -R 770 /usr/cache
- สร้างผู้ใช้
gitlab-deployer
และเพิ่มเข้ากลุ่มrunner
useradd -m -d /home/gitlab-deployer gitlab-deployer usermod -a -G runner gitlab-deployer
- เพิ่มลงในไฟล์
/etc/ssh/sshd_config
บรรทัดถัดไปAllowUsers root@* [email protected]
- รีบูต
sshd
systemctl 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 -> ปรับใช้โครงการ -> การตั้งค่า -> CI/CD -> นักวิ่ง -> นักวิ่งเฉพาะ และคัดลอกโทเค็นการลงทะเบียน
จอภาพ
- ลงทะเบียนนักวิ่ง
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 -> ปรับใช้โครงการ -> การตั้งค่า -> CI/CD -> นักวิ่ง -> นักวิ่งเฉพาะ -> นักวิ่งที่เปิดใช้งานสำหรับโปรเจ็กต์นี้
จอภาพ
- การเพิ่ม แยก บริการ
/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
การตั้งค่ามาเวน
- เราอยู่ภายใต้ผู้ใช้
gitlab-deployer
su 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
เสร็จสิ้นการตั้งค่านักวิ่ง คุณสามารถไปยังส่วนนี้ได้
นักวิ่งที่แชร์
การสร้างคีย์ 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 -> ตัวแปร และบันทึกคีย์ส่วนตัวในตัวแปร
GPG_SECRET_KEY
การตั้งค่ามาเวน
- สร้างคีย์หลัก
mvn --encrypt-master-password password {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}
- ไปที่การตั้งค่าโครงการ -> การตั้งค่า -> CI / CD -> ตัวแปร และบันทึกในตัวแปร
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 -> ตัวแปร และบันทึกในตัวแปร
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
ปรับใช้อิมเมจนักเทียบท่า
-
เราสร้าง Dockerfile ที่ค่อนข้างเรียบง่ายเพื่อรันงานเมื่อปรับใช้กับ Java เวอร์ชันที่ต้องการ ด้านล่างนี้เป็นตัวอย่างสำหรับอัลไพน์
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 ไปที่รูทของโปรเจ็กต์ปรับใช้
สคริปต์นำเสนองานการปรับใช้พิเศษสองงานที่ไม่เกิดร่วมกัน นักวิ่งเฉพาะหรือนักวิ่งร่วมตามลำดับ
.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 ที่ควรอัปโหลดไปยังที่เก็บข้อมูลสาธารณะ คุณต้องเพิ่ม 2 ขั้นตอนในการดาวน์โหลดเวอร์ชัน 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}
ในโซลูชันนี้ ฉันได้ดำเนินการเพิ่มเติมอีกเล็กน้อยและตัดสินใจใช้เทมเพลต CI หนึ่งเทมเพลตสำหรับโปรเจ็กต์ Java
รายละเอียดเพิ่มเติม
ฉันสร้างโครงการแยกต่างหาก
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-plugin.php
กำลังสร้าง 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 Central
ผล
การเผยแพร่เวอร์ชัน 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] ------------------------------------------------------------------------
ผลก็คือเราเหลือทางเลือกเดียวเท่านั้น หรือลบเวอร์ชันนี้หรือเผยแพร่
หลังจากปล่อยออกไปสักพัก อาร์ติแฟคก็จะเข้ามา
นอกหัวข้อ
เป็นการเปิดเผยสำหรับฉันที่ maven จัดทำดัชนีที่เก็บข้อมูลสาธารณะอื่น ๆ
ฉันต้องอัปโหลด robots.txt เพราะมันจัดทำดัชนีพื้นที่เก็บข้อมูลเก่าของฉัน
ข้อสรุป
สิ่งที่เรามี
- โปรเจ็กต์การปรับใช้แยกต่างหากซึ่งคุณสามารถใช้งาน CI หลายงานสำหรับการอัปโหลดอาร์ติแฟกต์ไปยังที่เก็บข้อมูลสาธารณะสำหรับภาษาการพัฒนาต่างๆ
- โปรเจ็กต์การปรับใช้งานถูกแยกออกจากการรบกวนจากภายนอก และสามารถแก้ไขได้โดยผู้ใช้ที่มีบทบาทเจ้าของและผู้ดูแลเท่านั้น
- รันเนอร์เฉพาะแยกต่างหากพร้อมแคช "ร้อน" เพื่อเรียกใช้งานปรับใช้เท่านั้น
- การเผยแพร่เวอร์ชันสแน็ปช็อต/เผยแพร่ในพื้นที่เก็บข้อมูลสาธารณะ
- ตรวจสอบเวอร์ชันรีลีสอัตโนมัติเพื่อความพร้อมในการเผยแพร่ใน Maven Central
- การป้องกันการเผยแพร่เวอร์ชัน "ดิบ" โดยอัตโนมัติใน Maven Central
- สร้างและเผยแพร่เวอร์ชันสแน็ปช็อต “เมื่อคลิก”
- พื้นที่เก็บข้อมูลเดียวสำหรับรับเวอร์ชันสแนปช็อต/เผยแพร่
- ไปป์ไลน์ทั่วไปสำหรับการสร้าง / การทดสอบ / การเผยแพร่โปรเจ็กต์ Java
การตั้งค่า GitLab CI ไม่ใช่เรื่องซับซ้อนอย่างที่คิดเมื่อเห็นแวบแรก การตั้งค่า CI แบบครบวงจรสองสามครั้งก็เพียงพอแล้ว และตอนนี้คุณยังห่างไกลจากมือสมัครเล่นในเรื่องนี้ นอกจากนี้ เอกสาร GitLab ยังซ้ำซ้อนมาก อย่ากลัวที่จะก้าวแรก ถนนปรากฏใต้บันไดคนเดิน (จำไม่ได้ว่าใครพูด :)
ฉันยินดีที่จะแสดงความคิดเห็น
ในบทความถัดไป ฉันจะแสดงวิธีตั้งค่า GitLab CI เพื่อรันงานการทดสอบการรวมที่สามารถแข่งขันได้ (การรันบริการทดสอบด้วย docker-compose) หากคุณมีเชลล์รันเนอร์เพียงอันเดียว
ที่มา: will.com