Configuración de GitLab CI para cargar un proyecto java en maven central

Este artículo está dirigido a desarrolladores de Java que necesitan publicar rápidamente sus productos en los repositorios centrales de Sonatype y/o Maven utilizando GitLab. En este artículo, hablaré sobre cómo configurar gitlab-runner, gitlab-ci y maven-plugin para resolver este problema.

Requisitos previos:

  • Almacenamiento seguro de claves mvn y GPG.
  • Ejecución segura de tareas de CI públicas.
  • Carga de artefactos (versión/instantánea) a repositorios públicos.
  • Verificación automática de las versiones de lanzamiento para su publicación en maven central.
  • Una solución general para cargar artefactos a un repositorio para múltiples proyectos.
  • Simplicidad y facilidad de uso.

contenido

Información general

  • Ya se describe una descripción detallada del mecanismo para publicar artefactos en Maven Central a través del servicio de alojamiento del repositorio OSS de Sonatype en este articulo usuario Googolplex, por lo que consultaré este artículo en los lugares correctos.
  • Preinscribirse en Sonatipo JIRA e iniciar un ticket para abrir el repositorio (para más detalles, lea la sección Crear un ticket Sonatype JIRA). Después de abrir el repositorio, el par de inicio de sesión/contraseña de JIRA (en adelante, la cuenta de Sonatype) se utilizará para cargar artefactos en Sonatype nexus.
  • Además, el proceso de generación de una clave GPG se describe de forma muy seca. Consulte la sección para obtener más detalles. Configurar GnuPG para firmar artefactos
  • Si está utilizando la consola Linux para generar una clave GPG (gnupg/gnupg2), entonces necesita instalar rng-tools para generar entropía. De lo contrario, la generación de claves puede llevar mucho tiempo.
  • Servicios de almacenamiento публичных claves GPG

Al contenido

Configurar un proyecto de implementación en GitLab

  • En primer lugar, debe crear y configurar un proyecto en el que se almacenará la canalización para la implementación de artefactos. Llamé a mi proyecto de manera simple y sin complicaciones. desplegar
  • Después de crear el repositorio, debe restringir el acceso para cambiar el repositorio.
    Vaya al proyecto -> Configuración -> Repositorio -> Ramas protegidas. Eliminamos todas las reglas y agregamos una sola regla con comodín * con derecho a insertar y fusionar solo para usuarios con el rol de mantenedores. Esta regla funcionará para todos los usuarios tanto de este proyecto como del grupo al que pertenece este proyecto.
    Configuración de GitLab CI para cargar un proyecto java en maven central
  • Si hay varios mantenedores, la mejor solución sería, en principio, restringir el acceso al proyecto.
    Vaya al proyecto -> Configuración -> General -> Visibilidad, características del proyecto, permisos y configure la visibilidad del proyecto en Privado.
    Tengo un proyecto en acceso público, ya que uso mi propio GitLab Runner y solo yo tengo acceso para modificar el repositorio. Bueno, en realidad no me conviene mostrar información privada en los registros públicos de tuberías.
  • Endurecer las reglas para cambiar el repositorio.
    Vaya al proyecto -> Configuración -> Repositorio -> Reglas de inserción y establezca las banderas Restricción del confirmador. Verifique si el autor es un usuario de GitLab. También recomiendo configurar comprometerse a firmary establezca el indicador Rechazar confirmaciones sin firmar.
  • A continuación, debe configurar un activador para ejecutar tareas.
    Vaya al proyecto -> Configuración -> CI/CD -> Activadores de canalización y cree un nuevo token de activación
    Este token se puede agregar inmediatamente a la configuración general de variables para un grupo de proyectos.
    Vaya al grupo -> Configuración -> CI/CD -> Variables y agregue una variable DEPLOY_TOKEN con token de activación en el valor.

Al contenido

Corredor de GitLab

Esta sección describe la configuración para ejecutar tareas durante la implementación utilizando el ejecutor nativo (específico) y público (compartido).

Corredor específico

Utilizo mis propios corredores porque, ante todo, es conveniente, rápido y económico.
Para runner recomiendo Linux VDS con 1 CPU, 2 GB de RAM, 20 GB de disco duro. Precio de emisión ~ 3000₽ por año.

mi corredor

Para el corredor tomé CPU VDS 4, 4 GB de RAM, 50 GB de SSD. Cuesta ~11000₽ y nunca me arrepiento.
Tengo un total de 7 máquinas. 5 en aruba y 2 en ihor.

Entonces, tenemos un corredor. Ahora lo configuraremos.
Nos dirigimos a la máquina vía SSH e instalamos java, git, maven, gnupg2.

Al contenido

Instalando el corredor gitlab

  • Crear un nuevo grupo runner
    sudo groupadd runner
  • Cree un directorio para el caché de Maven y asigne derechos de grupo runner
    Puedes omitir este paso si no planeas ejecutar varios corredores en la misma máquina.

    mkdir -p /usr/cache/.m2/repository
    chown -R :runner /usr/cache
    chmod -R 770 /usr/cache
  • Crear un usuario gitlab-deployer y agregar al grupo runner
    useradd -m -d /home/gitlab-deployer gitlab-deployer
    usermod -a -G runner gitlab-deployer
  • Agregar al archivo /etc/ssh/sshd_config Proxima linea
    AllowUsers root@* [email protected]
  • Reiniciar sshd
    systemctl restart sshd
  • Establecer una contraseña para el usuario gitlab-deployer (puede ser sencillo, ya que existe una restricción para localhost)
    passwd gitlab-deployer
  • Instalar 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
  • Vaya a gitlab.com -> implementar-proyecto -> Configuración -> CI/CD -> Corredores -> Corredores específicos y copie el token de registro

Pantalla

Configuración de GitLab CI para cargar un proyecto java en maven central

  • Registrar al corredor
    gitlab-runner register --config /etc/gitlab-runner/gitlab-deployer-config.toml

proceso

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!

  • Comprueba que el corredor está registrado. Vaya a gitlab.com -> implementar-proyecto -> Configuración -> CI/CD -> Corredores -> Corredores específicos -> Corredores activados para este proyecto

Pantalla

Configuración de GitLab CI para cargar un proyecto java en maven central

  • Agregar separado servicio /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
  • Iniciamos el servicio.
    systemctl enable gitlab-deployer.service
    systemctl start gitlab-deployer.service
    systemctl status gitlab-deployer.service
  • Compruebe que el corredor esté en marcha.

ejemplo

Configuración de GitLab CI para cargar un proyecto java en maven central

Al contenido

Generación de claves GPG

  • Desde la misma máquina vamos vía ssh bajo el usuario gitlab-deployer (esto es importante para la generación de claves GPG)

    ssh [email protected]

  • Generamos una clave respondiendo preguntas. Usé mi propio nombre y correo electrónico.
    Asegúrese de especificar la contraseña de la clave. Los artefactos se firmarán con esta clave.

    gpg --gen-key 

  • Cheque

    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

  • Subiendo nuestra clave pública al servidor de claves

    gpg --keyserver keys.gnupg.net --send-key 00000000
    gpg: sending key 00000000 to hkp server keys.gnupg.net

Al contenido

Configuración experta

  • Pasamos debajo del usuario. gitlab-deployer
    su gitlab-deployer 
  • Crear un directorio maven repositorio y vincular con el caché (no te equivoques)
    Puedes omitir este paso si no planeas correr varios corredores en la misma máquina.

    mkdir -p ~/.m2/repository
    ln -s /usr/cache/.m2/repository /home/gitlab-deployer/.m2/repository
  • Crear una clave maestra
    mvn --encrypt-master-password password
    {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}
  • Crear archivo ~/.m2/settings-security.xml
    <settingsSecurity>
    <master>{hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}</master>
    </settingsSecurity>
  • Cifrar la contraseña de la cuenta de Sonatype
    mvn --encrypt-password SONATYPE_PASSWORD
    {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J}
  • Crear archivo ~/.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>

donde
GPG_SECRET_KEY_PASSPHRASE - Contraseña de clave GPG
SONATYPE_USERNAME - inicio de sesión de cuenta sonatype

Esto completa la configuración del corredor, puede continuar con la sección CI de GitLab

Al contenido

Corredor compartido

Generación de claves GPG

  • En primer lugar, necesitas crear una clave GPG. Para hacer esto, instale gnupg.

    yum install -y gnupg

  • Generamos una clave respondiendo preguntas. Usé mi propio nombre y correo electrónico. Asegúrese de especificar la contraseña de la clave.

    gpg --gen-key 

  • Recuperar información clave

    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]

  • Subiendo nuestra clave pública al servidor de claves

    gpg --keyserver keys.gnupg.net --send-key 2D0D1706366FC4AEF79669E24D09C55BBA3FD728
    gpg: sending key 2D0D1706366FC4AEF79669E24D09C55BBA3FD728 to hkp server keys.gnupg.net

  • Obtener una clave privada

    gpg --export-secret-keys --armor 2D0D1706366FC4AEF79669E24D09C55BBA3FD728
    -----BEGIN PGP PRIVATE KEY BLOCK-----
    lQWGBFzAqp8BDADN41CPwJ/gQwiKEbyA902DKw/WSB1AvZQvV/ZFV77xGeG4K7k5
    ...
    =2Wd2
    -----END PGP PRIVATE KEY BLOCK-----

  • Vaya a la configuración del proyecto -> Configuración -> CI/CD -> Variables y guarde la clave privada en una variable GPG_SECRET_KEY
    Configuración de GitLab CI para cargar un proyecto java en maven central

Al contenido

Configuración experta

  • Crear una clave maestra
    mvn --encrypt-master-password password
    {hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}
  • Vaya a la configuración del proyecto -> Configuración -> CI/CD -> Variables y guárdelo en una variable SETTINGS_SECURITY_XML las siguientes líneas:
    <settingsSecurity>
    <master>{hnkle5BJ9HUHUMP+CXfGBl8dScfFci/mpsur/73tR2I=}</master>
    </settingsSecurity>
  • Cifrar la contraseña de la cuenta de Sonatype
    mvn --encrypt-password SONATYPE_PASSWORD
    {98Wv5+u+Tn0HX2z5G/kR4R8Z0WBgcDBgi7d12S/un+SCU7uxzaZGGmJ8Cu9pAZ2J}
  • Vaya a la configuración del proyecto -> Configuración -> CI/CD -> Variables y guárdelo en una variable SETTINGS_XML las siguientes líneas:
    <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>

donde
GPG_SECRET_KEY_PASSPHRASE - Contraseña de clave GPG
SONATYPE_USERNAME - inicio de sesión de cuenta sonatype

Al contenido

Implementar imagen acoplable

  • Creamos un Dockerfile bastante simple para ejecutar tareas durante la implementación con la versión deseada de Java. A continuación se muestra un ejemplo para alpino.

    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/

  • Construyendo un contenedor para su proyecto

    docker build -t registry.gitlab.com/group/deploy .

  • Autenticamos y cargamos el contenedor en el registro.

    docker login -u USER -p PASSWORD registry.gitlab.com
    docker push registry.gitlab.com/group/deploy

Al contenido

CI de GitLab

Implementar proyecto

Agregue el archivo .gitlab-ci.yml a la raíz del proyecto de implementación
El script presenta dos tareas de implementación mutuamente excluyentes. Runner específico o Runner compartido respectivamente.

.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

Al contenido

Proyecto Java

En proyectos de Java que se supone que deben cargarse en repositorios públicos, debe agregar 2 pasos para descargar las versiones Release y 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}

En esta solución, fui un poco más allá y decidí usar una plantilla de CI para proyectos Java.

Más detalles

Creé un proyecto separado gitlab-ci en el que colocó la plantilla CI para proyectos java común.yml.

común.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

Como resultado, en los propios proyectos de Java, .gitlab-ci.yml parece muy compacto y no detallado.

.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

Al contenido

configuración pom.xml

Este tema se describe con gran detalle. Googolplex в Configurar maven para firmar y cargar automáticamente artefactos en repositorios de instantáneas y de preparación, así que describiré algunos de los matices del uso de complementos. También describiré con qué facilidad y naturalidad puedes utilizar nexus-staging-maven-pluginsi no quiere o no puede usar org.sonatype.oss:oss-parent como padre de su proyecto.

maven-instalar-complemento

Instala módulos en el repositorio local.
Muy útil para verificación local de soluciones en otros proyectos, así como suma de verificación.

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

Al contenido

complemento-maven-javadoc

Generando javadoc para el proyecto.

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

Si tiene un módulo que no contiene java (por ejemplo, solo recursos)
O no desea generar javadoc en principio, entonces para ayudar 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>

Al contenido

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

Al contenido

complemento-maven-puesta en escena de nexus

Configuración:

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

Si tiene un proyecto de varios módulos y no necesita cargar un módulo específico al repositorio, debe agregarlo al pom.xml de este módulo. nexus-staging-maven-plugin con bandera skipNexusStagingDeployMojo

<build>
  <plugins>
    <plugin>
      <groupId>org.sonatype.plugins</groupId>
      <artifactId>nexus-staging-maven-plugin</artifactId>
      <configuration>
        <skipNexusStagingDeployMojo>true</skipNexusStagingDeployMojo>
      </configuration>
    </plugin>
  </plugins>
</build>

Después de cargar la instantánea/las versiones de lanzamiento están disponibles en repositorios provisionales

<repositories>
  <repository>
    <id>SonatypeNexus</id>
    <url>https://oss.sonatype.org/content/groups/staging/</url>
    <!-- Не надо указывать флаги snapshot/release для репозитория -->
  </repository>
</repositories>

Más ventajas

  • Una lista muy rica de objetivos para trabajar con el repositorio nexus (mvn help:describe -Dplugin=org.sonatype.plugins:nexus-staging-maven-plugin).
  • Comprobación de versión automática para descarga en maven central

Al contenido

resultado

Publicar una versión INSTANTÁNEA

Al construir un proyecto, es posible iniciar manualmente una tarea para descargar la versión SNAPSHOT a Nexus

Configuración de GitLab CI para cargar un proyecto java en maven central

Cuando se inicia esta tarea, se activa la tarea correspondiente en el proyecto de implementación (ejemplo).

tronco recortado

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

Como resultado, se carga la versión Nexus. 1.0.0-SNAPSHOT.

Todas las versiones de instantáneas se pueden eliminar del repositorio del sitio. oss.sonatype.org bajo su cuenta.

Configuración de GitLab CI para cargar un proyecto java en maven central

Al contenido

Publicación de la versión de lanzamiento.

Cuando se establece la etiqueta, la tarea correspondiente en el proyecto de implementación se activa automáticamente para cargar la versión de lanzamiento en Nexus (ejemplo).

Configuración de GitLab CI para cargar un proyecto java en maven central

La mejor parte es que la liberación cercana se activa automáticamente en el nexo.

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

Y si algo salió mal, la tarea fracasará.

[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 &lt;a href=http://keys.gnupg.net:11371/&gt;http://keys.gnupg.net:11371/&lt;/a&gt;. 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] ------------------------------------------------------------------------

Como resultado, sólo nos queda una opción. O eliminar esta versión o publicarla.

Configuración de GitLab CI para cargar un proyecto java en maven central

Después del lanzamiento, después de algún tiempo, los artefactos estarán en Configuración de GitLab CI para cargar un proyecto java en maven central

offtop

Fue una revelación para mí que Maven indexe otros repositorios públicos.
Tuve que subir robots.txt porque indexaba mi antiguo repositorio.

Al contenido

Conclusión

Que tenemos

  • Un proyecto de implementación independiente en el que puede implementar varias tareas de CI para cargar artefactos en repositorios públicos para varios lenguajes de desarrollo.
  • El proyecto de implementación está aislado de interferencias externas y solo pueden modificarlo usuarios con los roles de Propietario y Mantenedor.
  • Un ejecutor específico independiente con una caché "activa" para ejecutar únicamente tareas de implementación.
  • Publicación de versiones instantáneas/de lanzamiento en un repositorio público.
  • Comprobación automática de que la versión de lanzamiento esté lista para su publicación en maven central.
  • Protección contra la publicación automática de versiones “sin procesar” en maven central.
  • Cree y publique versiones instantáneas "al hacer clic".
  • Repositorio único para obtener versiones instantáneas/de lanzamiento.
  • Canal general para construir/probar/publicar un proyecto Java.

Configurar GitLab CI no es un tema tan complicado como parece a primera vista. Basta con configurar CI llave en mano un par de veces, y ahora estás lejos de ser un aficionado en este asunto. Además, la documentación de GitLab es muy redundante. No tengas miedo de dar el primer paso. El camino aparece bajo los pasos de la persona que camina (no recuerdo quién lo dijo :)

Estaré encantado de recibir comentarios.

En el siguiente artículo, le mostraré cómo configurar GitLab CI para ejecutar tareas de prueba de integración de manera competitiva (ejecutando servicios de prueba con docker-compose) si solo tiene un ejecutor de shell.

Al contenido

Fuente: habr.com

Añadir un comentario