إعداد GitLab CI لتحميل مشروع java إلى maven Central

هذه المقالة مخصصة لمطوري جافا الذين يحتاجون إلى نشر منتجاتهم بسرعة إلى sonatype و / أو إنشاء مستودعات مركزية باستخدام GitLab. في هذه المقالة ، سأتحدث عن إعداد gitlab-runner و gitlab-ci و maven-plugin لحل هذه المشكلة.

المتطلبات الأساسية:

• تخزين آمن لمفاتيح mvn و GPG.
• تأمين تنفيذ مهام CI العامة.
• تحميل القطع الأثرية (إصدار / لقطة) إلى المستودعات العامة.
• فحص تلقائي لإصدارات الإصدار للنشر في Maven Central.
• حل عام لتحميل القطع الأثرية إلى مستودع لمشاريع متعددة.
• البساطة وسهولة الاستخدام.

محتوى

• معلومات عامة
• إعداد مشروع نشر في GitLab
• عداء جيت لاب
  • عداء محدد
    • تثبيت عداء gitlab
    • جيل مفتاح GPG
    • إعداد المخضرم
  • عداء مشترك
    • جيل مفتاح GPG
    • إعداد المخضرم
    • نشر صورة عامل ميناء
• جيت لاب CI
  • نشر المشروع
  • مشروع جافا
• تكوين pom.xml
  • maven-install-plugin
  • maven-javadoc-plugin
  • مخضرم-GPG-البرنامج المساعد
  • nexus-staging-maven-plugin
• نتيجة
  • نشر نسخة لقطة
  • نشر نسخة الإصدار
• اختتام

معلومات عامة

• وصف مفصل لآلية نشر القطع الأثرية إلى Maven Central عبر خدمة استضافة مستودع Sonatype OSS موصوفة بالفعل في هذا المقال المستعمل غوغل بلكس، لذلك سوف أشير إلى هذه المقالة في الأماكن الصحيحة.
• التسجيل المسبق في سوناتايب جيرا وابدأ تذكرة لفتح المستودع (لمزيد من التفاصيل ، اقرأ القسم قم بإنشاء تذكرة Sonatype JIRA). بعد فتح المستودع ، سيتم استخدام زوج تسجيل الدخول / كلمة المرور لـ JIRA (المشار إليه فيما يلي باسم حساب Sonatype) لتحميل الأدوات إلى رابط Sonatype.
• علاوة على ذلك ، يتم وصف عملية إنشاء مفتاح GPG بشكل جاف للغاية. انظر القسم لمزيد من التفاصيل. تكوين GnuPG لتوقيع المشغولات
• إذا كنت تستخدم وحدة تحكم Linux لإنشاء مفتاح GPG (gnupg / gnupg2) ، فأنت بحاجة إلى التثبيت RNG الأدوات لتوليد الانتروبيا. خلاف ذلك ، قد يستغرق إنشاء المفاتيح وقتًا طويلاً جدًا.
• خدمات التخزين عام مفاتيح GPG
  • http://keys.gnupg.net
  • http://pool.sks-keyservers.net
  • http://keyserver.ubuntu.com

إلى المحتوى

إعداد مشروع نشر في GitLab

• بادئ ذي بدء ، تحتاج إلى إنشاء وتكوين مشروع يتم فيه تخزين خط الأنابيب لنشر القطع الأثرية. لقد اتصلت بمشروعي ببساطة وغير معقد - نشر
• بعد إنشاء المستودع ، تحتاج إلى تقييد الوصول لتغيير المستودع.
  انتقل إلى المشروع -> الإعدادات -> المستودع -> الفروع المحمية. نحذف جميع القواعد ونضيف قاعدة واحدة مع Wildcard * مع الحق في الدفع والدمج فقط للمستخدمين الذين لديهم دور الصيانة. ستعمل هذه القاعدة مع جميع مستخدمي هذا المشروع والمجموعة التي ينتمي إليها هذا المشروع.
  
• إذا كان هناك العديد من المشرفين ، فإن أفضل حل هو تقييد الوصول إلى المشروع من حيث المبدأ.
  انتقل إلى المشروع -> الإعدادات -> عام -> الرؤية وميزات المشروع والأذونات وتعيين رؤية المشروع على خاص.
  لديّ مشروع في الوصول العام ، حيث إنني أستخدم GitLab Runner الخاص بي وليس لدي سوى حق الوصول لتعديل المستودع. حسنًا ، ليس من مصلحتي في الواقع إظهار المعلومات الخاصة في سجلات خطوط الأنابيب العامة.
• تشديد قواعد تغيير المستودع
  انتقل إلى المشروع -> الإعدادات -> المستودع -> قواعد الدفع وقم بتعيين قيود Committer الخاصة بالعلامات ، وتحقق مما إذا كان المؤلف من مستخدمي GitLab. أوصي أيضًا بالإعداد الالتزام بالتوقيع، وقم بتعيين علامة عمليات رفض غير الموقعة.
• بعد ذلك ، تحتاج إلى تكوين مشغل لتشغيل المهام
  انتقل إلى المشروع -> الإعدادات -> CI / CD -> مشغلات خط الأنابيب وأنشئ رمزًا جديدًا للمشغل
  يمكن إضافة هذا الرمز المميز على الفور إلى التكوين العام للمتغيرات لمجموعة من المشاريع.
  انتقل إلى المجموعة -> الإعدادات -> CI / CD -> المتغيرات وأضف متغيرًا DEPLOY_TOKEN مع رمز المشغل في القيمة.

إلى المحتوى

عداء جيت لاب

يصف هذا القسم التكوين لتشغيل المهام عند النشر باستخدام عداء أصلي (محدد) وعام (مشترك).

عداء محدد

أستخدم العدائين الخاصين بي ، لأنه أولاً وقبل كل شيء مريح وسريع ورخيص.
بالنسبة للعداء ، أوصي بـ Linux VDS مع وحدة معالجة مركزية واحدة ، وذاكرة وصول عشوائي 1 جيجا بايت ، و 2 جيجا بايت HDD. سعر الإصدار ~ 20 في السنة.

عداء بلدي

بالنسبة للعداء ، أخذت VDS 4 CPU و 4 غيغابايت من ذاكرة الوصول العشوائي و 50 غيغابايت SSD. تكلف حوالي 11000 ولم يندم عليها أبدًا.
لدي ما مجموعه 7 آلات. 5 على أروبا و 2 على ihor.

لذلك ، لدينا عداء. الآن سنقوم بإعداده.
نذهب إلى الجهاز عبر SSH ونثبت java و git و maven و gnupg2.

إلى المحتوى

تثبيت عداء gitlab

• أنشئ مجموعة جديدة runner

  sudo groupadd runner

• إنشاء دليل لذاكرة التخزين المؤقت المخبأة وتعيين حقوق المجموعة 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 (يمكن أن يكون الأمر بسيطًا ، نظرًا لوجود قيود على المضيف المحلي)

  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 -> publish-project -> Settings -> 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 -> publish-project -> Settings -> 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 

• إنشاء دليل مخضرم مستودع والربط مع ذاكرة التخزين المؤقت (لا تخطئ)
  يمكن تخطي هذه الخطوة إذا كنت لا تخطط لتشغيل عدة عدائين على نفس الجهاز.

  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

هذا يكمل إعداد العداء ، يمكنك المتابعة إلى القسم جيت لاب CI

إلى المحتوى

عداء مشترك

جيل مفتاح 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

إلى المحتوى

جيت لاب 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

إلى المحتوى

مشروع جافا

في مشاريع جافا التي من المفترض أن يتم تحميلها على المستودعات العامة ، تحتاج إلى إضافة خطوتين لتنزيل إصداري الإصدار واللقطة.

.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 واحد لمشاريع جافا.

مزيد من التفاصيل

لقد أنشأت مشروعًا منفصلاً جيتلاب سي حيث وضع نموذج CI لمشاريع جافا common.yml.

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

نتيجة لذلك ، في مشاريع جافا نفسها ، يبدو .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-install-plugin

تثبيت الوحدات في المستودع المحلي.
مفيد جدًا للتحقق المحلي من الحلول في المشاريع الأخرى ، بالإضافة إلى المجموع الاختباري.

<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

توليد جافادوك للمشروع.

<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>

إذا كان لديك وحدة لا تحتوي على جافا (على سبيل المثال الموارد فقط)
أو أنك لا تريد إنشاء 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>

إلى المحتوى

مخضرم-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-plugin

إعدادات:

<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).
• فحص الإصدار التلقائي لقابلية التنزيل في مركز المخضرم

إلى المحتوى

نتيجة

نشر إصدار 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 1.0.0-لقطة.

يمكن إزالة جميع إصدارات اللقطات من المستودع على الموقع oss.sonatype.org تحت حسابك.

إلى المحتوى

نشر نسخة الإصدار

عند تعيين العلامة ، يتم تشغيل المهمة المقابلة في مشروع النشر تلقائيًا لتحميل نسخة الإصدار إلى 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 لتحميل الأدوات إلى المستودعات العامة للغات التطوير المختلفة.
• يتم عزل مشروع النشر عن التداخل الخارجي ولا يمكن تعديله إلا من قبل المستخدمين الذين لديهم دور المالك والقائمين على الصيانة.
• مشغل خاص منفصل مزود بذاكرة تخزين مؤقت "ساخنة" لتشغيل مهام النشر فقط.
• نشر إصدارات لقطة / إصدار في مستودع عام.
• فحص تلقائي لنسخة الإصدار للتأكد من جاهزيتها للنشر في Maven Central.
• الحماية ضد النشر التلقائي للإصدارات "الخام" في maven Central.
• إنشاء نسخ سريعة ونشرها "عند النقر".
• مستودع واحد للحصول على إصدارات لقطة / إصدار.
• خط أنابيب عام لبناء / اختبار / نشر مشروع جافا.

لا يعد إعداد GitLab CI موضوعًا معقدًا كما يبدو للوهلة الأولى. يكفي إعداد CI على أساس تسليم المفتاح عدة مرات، والآن أنت بعيد عن الهواة في هذا الشأن. علاوة على ذلك، فإن وثائق GitLab زائدة عن الحاجة. لا تخف من اتخاذ الخطوة الأولى. يظهر الطريق تحت خطوات الماشي (لا أتذكر من قال ذلك :)

سأكون سعيدا لردود الفعل.

في المقالة التالية ، سأوضح لك كيفية إعداد GitLab CI لتشغيل مهام اختبار التكامل بشكل تنافسي (تشغيل خدمات الاختبار باستخدام docker-compose) إذا كان لديك عداء صدفة واحد فقط.

إلى المحتوى

المصدر: www.habr.com