Перейти к содержанию

Maven

Требования

Для работы с пакетами Maven требуется официальная утилита.

Проверьте наличие утилиты:

mvn --version

В случае, если утилита не установлена, используйте команду:

sudo apt install maven

Добавление пакета Maven

Для добавления пакета Maven, необходимо получить транспортный токен Gitflic. С инструкцией по получению токена можно ознакомиться на странице.

В документации ниже встречается атрибут <домен_gitflic> На его место необходимо указать домен, в зависимости от версии:

  • для SaaS версии registry.gitflic.ru

  • для self-hosted localhost:8080

Домен и порт для self-hosted версии может отличаться.

Файл настроек settings.xml

Перед загрузкой пакета Maven необходимо создать файл настройки. Как правило, его создают в домашней директории {Домашняя}.m2/settings.xml.

Ознакомиться с подробной документацией для файла settings можно здесь. Примерное содержание файла настроек может выглядеть так:

Атрибут id можно заполнить как удобно, для примера выбрано значение gitflic

Значение атрибута url зависит от уровня доступа:

Уровень URL
Проект http(s)://<домен_gitflic>/project/{ownerAlias}/{projectAlias}/package/-/maven
Компания http(s)://<домен_gitflic>/company/{companyAlias}/package/-/maven
Инстанс http(s)://<домен_gitflic>/package/-/maven
Переменная в URL Описание
ownerAlias Псевдоним владельца проекта
projectAlias Псевдоним проекта
companyAlias Псевдоним компании
<settings>
    <servers>
        <server>
            <id>gitflic</id>
            <username>{username}</username>
            <password>{token}</password>
        </server>
    </servers>

    <activeProfiles>
        <activeProfile>gitflic</activeProfile>
    </activeProfiles>

    <profiles>
        <profile>
            <id>gitflic</id>
            <repositories>
                <repository>
                    <id>gitflic</id>
                    <url>{выбранный url}</url>
                </repository>
            <snapshots>
                <enabled>true</enabled>
                <updatePolicy>always</updatePolicy>
            </snapshots>
            </repositories>
        </profile>
    </profiles>
</settings>

Конфигурационный файл pom.xml

Прежде всего в локальном репозитории необходимо создать файл конфигурации pom.xml. В данном файле обязательно должны присутствовать разделы distributionManagement и repository. Ознакомиться с подробной документацией для файла pom можно здесь. Корректное содержание конфигурационного файла может выглядеть так:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>gitflic</groupId>
  <artifactId>gitflic</artifactId>
  <version>1.0.0</version>

<repositories>
  <repository>
    <id>gitflic</id>
    <url>{url реестра}</url>
  </repository>
</repositories>

<distributionManagement>
  <repository>
    <id>gitflic</id>
    <url>{url реестра}</url>
  </repository>
  <snapshotRepository>
    <id>gitflic</id>
    <url>{url реестра}</url>
  </snapshotRepository>
</distributionManagement>
</project>

Публикация пакета

После выполнения настройки конфигурационных файлов можно публиковать пакет. Для этого необходимо выполнить команду

mvn deploy

Если публикация пакета прошла успешно, то появится сообщение следующего содержания:

...
[INFO] BUILD SUCCESS
...

Скачивание пакета

Для скачивания пакета необходимо в файл pom.xml вставить следующие данные:

<dependency>
    <groupId><ID Группы></groupId>
    <artifactId><ID артефакта></artifactId>
    <version><Версия></version>
</dependency>

Версия пакета указывается в формате X.X.X

Далее необходимо запустить через командную строку

mvn install