Размещение репозитория Maven на github

Лучшее решение, которое мне удалось найти, состоит из следующих шагов:

1. Создайте ветку с именем mvn-repo для размещения ваших артефактов maven.
2. Используйте site-maven-plugin github, чтобы отправить свои артефакты на github.
3. Настройте maven для использования вашего удаленного mvn-repo в качестве репозитория maven.

У этого подхода есть несколько преимуществ:

• Артефакты Maven хранятся отдельно от вашего источника в отдельной ветке под названием mvn-repo, так же, как страницы github хранятся в отдельной ветке под названием gh-pages (если вы используете страницы github)
• В отличие от некоторых других предлагаемых решений, оно не конфликтует с вашим gh-pages, если вы их используете.
• Естественно связан с целью развертывания, поэтому нет новых команд maven для изучения. Просто используйте mvn deploy, как обычно

Типичный способ развертывания артефактов в удаленном репозитории maven - использовать mvn deploy, поэтому давайте внесем исправления в этот механизм для этого решения.

Сначала скажите maven развернуть артефакты во временном промежуточном месте внутри вашего целевого каталога. Добавьте это в свой pom.xml:

<distributionManagement>
    <repository>
        <id>internal.repo</id>
        <name>Temporary Staging Repository</name>
        <url>file://${project.build.directory}/mvn-repo</url>
    </repository>
</distributionManagement>

<plugins>
    <plugin>
        <artifactId>maven-deploy-plugin</artifactId>
        <version>2.8.1</version>
        <configuration>
            <altDeploymentRepository>internal.repo::default::file://${project.build.directory}/mvn-repo</altDeploymentRepository>
        </configuration>
    </plugin>
</plugins>

Теперь попробуйте запустить mvn clean deploy. Вы увидите, что он развернул ваш репозиторий maven на target/mvn-repo. Следующий шаг - заставить его загрузить этот каталог на GitHub.

Добавьте свою информацию для аутентификации в ~/.m2/settings.xml, чтобы github site-maven-plugin мог отправить на GitHub:

<!-- NOTE: MAKE SURE THAT settings.xml IS NOT WORLD READABLE! -->
<settings>
  <servers>
    <server>
      <id>github</id>
      <username>YOUR-USERNAME</username>
      <password>YOUR-PASSWORD</password>
    </server>
  </servers>
</settings>

(Как уже отмечалось, не забудьте chmod 700 settings.xml, чтобы никто не мог прочитать ваш пароль в файле. Если кто-то знает, как сделать запрос пароля site-maven-plugin вместо того, чтобы запрашивать его в файле конфигурации, дайте мне знать.)

Затем сообщите GitHub site-maven-plugin о новом сервере, который вы только что настроили, добавив в свой pom следующее:

<properties>
    <!-- github server corresponds to entry in ~/.m2/settings.xml -->
    <github.global.server>github</github.global.server>
</properties>

Наконец, настройте site-maven-plugin для загрузки из вашего временного промежуточного репозитория в ветку mvn-repo на Github:

<build>
    <plugins>
        <plugin>
            <groupId>com.github.github</groupId>
            <artifactId>site-maven-plugin</artifactId>
            <version>0.11</version>
            <configuration>
                <message>Maven artifacts for ${project.version}</message>  <!-- git commit message -->
                <noJekyll>true</noJekyll>                                  <!-- disable webpage processing -->
                <outputDirectory>${project.build.directory}/mvn-repo</outputDirectory> <!-- matches distribution management repository url above -->
                <branch>refs/heads/mvn-repo</branch>                       <!-- remote branch name -->
                <includes><include>**/*</include></includes>
                <repositoryName>YOUR-REPOSITORY-NAME</repositoryName>      <!-- github repo name -->
                <repositoryOwner>YOUR-GITHUB-USERNAME</repositoryOwner>    <!-- github username  -->
            </configuration>
            <executions>
              <!-- run site-maven-plugin's 'site' target as part of the build's normal 'deploy' phase -->
              <execution>
                <goals>
                  <goal>site</goal>
                </goals>
                <phase>deploy</phase>
              </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Ветка mvn-repo не обязательно должна существовать, она будет создана для вас.

Теперь снова запустите mvn clean deploy. Вы должны увидеть, как maven-deploy-plugin «загружает» файлы в ваш локальный промежуточный репозиторий в целевой каталог, затем site-maven-plugin фиксирует эти файлы и отправляет их на сервер.

[INFO] Scanning for projects...
[INFO]                                                                         
[INFO] ------------------------------------------------------------------------
[INFO] Building DaoCore 1.3-SNAPSHOT
[INFO] ------------------------------------------------------------------------
...
[INFO] --- maven-deploy-plugin:2.5:deploy (default-deploy) @ greendao ---
Uploaded: file:///Users/mike/Projects/greendao-emmby/DaoCore/target/mvn-repo/com/greendao-orm/greendao/1.3-SNAPSHOT/greendao-1.3-20121223.182256-3.jar (77 KB at 2936.9 KB/sec)
Uploaded: file:///Users/mike/Projects/greendao-emmby/DaoCore/target/mvn-repo/com/greendao-orm/greendao/1.3-SNAPSHOT/greendao-1.3-20121223.182256-3.pom (3 KB at 1402.3 KB/sec)
Uploaded: file:///Users/mike/Projects/greendao-emmby/DaoCore/target/mvn-repo/com/greendao-orm/greendao/1.3-SNAPSHOT/maven-metadata.xml (768 B at 150.0 KB/sec)
Uploaded: file:///Users/mike/Projects/greendao-emmby/DaoCore/target/mvn-repo/com/greendao-orm/greendao/maven-metadata.xml (282 B at 91.8 KB/sec)
[INFO] 
[INFO] --- site-maven-plugin:0.7:site (default) @ greendao ---
[INFO] Creating 24 blobs
[INFO] Creating tree with 25 blob entries
[INFO] Creating commit with SHA-1: 0b8444e487a8acf9caabe7ec18a4e9cff4964809
[INFO] Updating reference refs/heads/mvn-repo from ab7afb9a228bf33d9e04db39d178f96a7a225593 to 0b8444e487a8acf9caabe7ec18a4e9cff4964809
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 8.595s
[INFO] Finished at: Sun Dec 23 11:23:03 MST 2012
[INFO] Final Memory: 9M/81M
[INFO] ------------------------------------------------------------------------

Посетите github.com в своем браузере, выберите ветку mvn-repo и убедитесь, что все ваши двоичные файлы теперь там.

Поздравляем!

Теперь вы можете развернуть свои артефакты maven в публичном репозитории бедняков, просто запустив mvn clean deploy.

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

<repositories>
    <repository>
        <id>YOUR-PROJECT-NAME-mvn-repo</id>
        <url>https://github.com/YOUR-USERNAME/YOUR-PROJECT-NAME/raw/mvn-repo/</url>
        <snapshots>
            <enabled>true</enabled>
            <updatePolicy>always</updatePolicy>
        </snapshots>
    </repository>
</repositories>

Теперь любой проект, для которого требуются ваши файлы jar, будет автоматически загружать их из репозитория github maven.

Изменить: чтобы избежать проблемы, упомянутой в комментариях («Ошибка при создании фиксации: недопустимый запрос. Для« свойства / имя », nil не является строкой.»), Убедитесь, что вы указали имя в своем профиле на github.

Не используйте GitHub в качестве репозитория Maven.

Изменить: этот вариант получил много голосов против, но без комментариев относительно того, почему. Это правильный вариант независимо от технических возможностей размещения на GitHub. Хостинг на GitHub является неправильным по всем причинам, изложенным ниже, и без комментариев я не могу улучшить ответ, чтобы прояснить ваши проблемы.

Лучший вариант - сотрудничать с исходным проектом

Лучший вариант - убедить исходный проект включить ваши изменения и придерживаться оригинала.

Альтернатива - сохранить свою вилку

Поскольку вы создали форк библиотеки с открытым исходным кодом, и ваш форк также является открытым, вы можете загрузить свой форк в Maven Central (прочтите Руководство по загрузке артефактов в центральный репозиторий), присвоив ему новый groupId и, возможно, новый artifactId.

Рассматривайте этот вариант только в том случае, если вы хотите поддерживать этот форк до тех пор, пока изменения не будут внесены в исходный проект, а затем вам следует отказаться от этого.

Серьезно подумайте, является ли форк правильным вариантом. Прочтите множество результатов Google по запросу "почему бы не использовать форк"

Рассуждения

Раздутие репозитория банками увеличивает размер загрузки без всякой пользы

Jar - это output вашего проекта, его можно в любой момент регенерировать из inputs, а ваше репо на GitHub должно содержать только inputs.

Не верите мне? Затем проверьте результаты Google на предмет «не хранить двоичные файлы в git».

Справка GitHub Работа с большими файлами расскажет вам то же самое. По общему признанию, jar-файлы не большие, но они больше, чем исходный код, и после того, как jar был создан выпуском, у них нет причин для версионирования - это то, для чего новый выпуск.

Определение нескольких репозиториев в pom.xml замедляет сборку на количество репозиториев, умноженное на количество артефактов

Стивен Коннолли говорит:

Если кто-то добавит ваше репо, это повлияет на его производительность сборки, поскольку теперь у них есть другое репо для проверки артефактов ... Это не большая проблема, если вам нужно добавить только одно репо ... Но проблема растет, и следующее, что вы знаете, Сборка maven проверяет 50 репозиториев для каждого артефакта, а время сборки - собака.

Верно! Maven необходимо проверить каждый артефакт (и его зависимости), определенный в вашем pom.xml, на соответствие каждому репозиторию, который вы определили, поскольку в любом из этих репозиториев может быть доступна более новая версия.

Попробуйте сами, и вы почувствуете боль от медленной сборки.

Лучшее место для артефактов - Maven Central, так как это центральное место для банок, а это означает, что ваша сборка будет проверять только одно место.

Вы можете узнать больше о репозиториях в документации Maven на странице Введение в репозитории

Вы можете использовать JitPack (бесплатно для общедоступных репозиториев Git), чтобы представить свой репозиторий GitHub как артефакт Maven. Это очень легко. Вашим пользователям нужно будет добавить это в свой pom.xml:

1. Добавить репозиторий:

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

2. Добавить зависимость:

<dependency>
    <groupId>com.github.User</groupId>
    <artifactId>Repo name</artifactId>
    <version>Release tag</version>
</dependency>

Как ответил в другом месте, идея состоит в том, что JitPack создаст ваше репозиторий GitHub и будет обслуживать банки. Требуется наличие файла сборки и выпуска GitHub.

Приятно то, что вам не нужно заниматься развертыванием и загрузкой. Поскольку вы не хотели поддерживать свой собственный репозиторий артефактов, он хорошо подходит для ваших нужд.

С 2019 года вы можете использовать новую функциональность под названием Реестр пакетов Github.

В основном процесс:

• создать новый токен личного доступа из настроек github
• добавьте информацию о репозитории и токене в свой settings.xml

• развернуть с помощью

  mvn deploy -Dregistry=https://maven.pkg.github.com/yourusername -Dtoken=yor_token  
  

Другой альтернативой является использование любого веб-хостинга с поддержкой webdav. Конечно, вам понадобится место для этого где-то, но его легко настроить и он является хорошей альтернативой запуску полноценного сервера nexus.

добавьте это в свой раздел сборки

     <extensions>
        <extension>
        <artifactId>wagon-webdav-jackrabbit</artifactId>
        <groupId>org.apache.maven.wagon</groupId>
        <version>2.2</version>
        </extension>
    </extensions>

Добавьте что-то подобное в раздел управления дистрибутивом

<repository>
    <id>release.repo</id>
    <url>dav:http://repo.jillesvangurp.com/releases/</url>
</repository>

Наконец, не забудьте настроить доступ к репозиторию в вашем settings.xml

добавьте это в раздел своих серверов

    <server>
        <id>release.repo</id>
        <username>xxxx</username>
        <password>xxxx</password>
    </server>

и определение раздела ваших репозиториев

            <repository>
                <id>release.repo</id>
                <url>http://repo.jillesvangurp.com/releases</url>
                <releases>
                    <enabled>true</enabled>
                </releases>
                <snapshots>
                    <enabled>false</enabled>
                </snapshots>
            </repository>

Наконец, если у вас есть стандартный хостинг php, вы можете использовать что-то вроде sabredav, чтобы добавить возможности webdav.

Преимущества: у вас есть собственный репозиторий maven. Недостатки: у вас нет никаких возможностей управления в nexus; где-то вам нужна настройка webdav

В качестве альтернативы Bintray предоставляет бесплатный хостинг репозиториев maven. Вероятно, это хорошая альтернатива Sonatype OSS и Maven Central, если вы абсолютно не хотите переименовывать groupId. Но, пожалуйста, по крайней мере, постарайтесь интегрировать свои изменения в исходную версию или переименовать и опубликовать в Central. Это облегчает другим использование вашей вилки.

Если у вас есть только сам файл aar или jar или вы просто не хотите использовать плагины - я создал простой сценарий оболочки. С ним вы можете добиться того же - опубликовать свои артефакты на Github и использовать его в качестве общедоступного репозитория Maven.

Я хотел бы добавить еще одну альтернативу, плагин Gradle, над которым я работал в последнее время: magik.

В основном это позволяет публиковать непосредственно в репозитории github, выступающем в качестве репозитория maven.