在github上托管Maven存储库

我所能找到的最佳解决方案包括以下步骤:

1. 创建一个名为mvn-repo的分支来托管您的maven工件。
2. 使用github site-maven-plugin将你的工件推送到github。
3. 配置maven以使用远程mvn-repo作为maven存储库。

使用这种方法有几个好处:

• Maven工件在名为mvn-repo的独立分支中与源代码分开保存，就像github页面保存在名为gh-pages的独立分支中一样(如果你使用github页面)
• 与其他一些建议的解决方案不同，如果你正在使用它们，它不会与你的gh-pages冲突。
• 与部署目标自然地结合在一起，因此不需要学习新的maven命令。只要像平常一样使用mvn deploy即可

将工件部署到远程maven repo的典型方法是使用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从你的临时临时回购上传到你的Github上的mvn-repo分支:

<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将文件“上载”到目标目录中的本地staging存储库，然后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分支，并验证所有二进制文件现在都在那里。

恭喜你!

你现在可以简单地通过运行mvn clean deploy将你的maven工件部署到穷人的公共回购。

您还需要执行另一个步骤，即配置依赖于您的pom的任何poms，以了解存储库的位置。添加以下片段到任何项目的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存储库下载它们。

编辑:以避免评论中提到的问题('创建提交错误:无效请求。对于'properties/name'， nil不是一个字符串。')，确保你在github上的配置文件中声明了一个名字。

另一种选择是使用任何支持webdav的虚拟主机。当然，你需要一些空间来放置它，但是它的设置很简单，是运行一个完整的nexus服务器的一个很好的替代方案。

将此添加到构建部分

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

向distributionManagement部分添加这样的内容

<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功能。

不要使用GitHub作为Maven资源库。

编辑:这个选项得到了很多反对票，但没有人评论为什么。不管在GitHub上实际托管的技术能力如何，这都是正确的选择。基于下面列出的所有原因，在GitHub上托管是错误的，没有评论，我无法改进答案来澄清您的问题。

最佳选择-与原项目合作

最好的选择是说服原始项目包含您的更改，并坚持使用原始项目。

选择-维护你自己的叉子

既然你已经创建了一个开源库，你的fork也是开源的，你可以通过给它一个新的groupId和一个新的artifactId来将你的fork上传到Maven Central(读将工件上传到中央存储库的指南)。

只有当您愿意维护这个分支直到更改被合并到原始项目中时，才考虑这个选项，然后您应该放弃这个选项。

认真考虑分叉是否是正确的选择。读取“为什么不用叉子?”的无数谷歌结果

推理

用jar填充存储库会增加下载大小，没有任何好处

一个jar是你项目的output，它可以在任何时候从它的inputs重新生成，并且你的GitHub回购应该只包含inputs。

不相信我?然后检查谷歌的“不要在git中存储二进制文件”结果。

GitHub的帮助处理大文件会告诉你同样的事情。诚然，jar并不大，但它们比源代码大，一旦一个版本创建了一个jar，它们就没有理由进行版本控制——这就是新版本的目的。

在pom.xml中定义多个repo会降低构建速度，其速度是存储库数量乘以工件数量

Stephen Connolly 说:

如果任何人添加了你的回购，他们会影响他们的构建性能 因为他们现在有另一个回购来检查文物…不是很大 如果你只需要添加一个回购…但问题越来越多 你知道的，你的专业版本是为每个工件检查50个回购 构建时间是一条狗。

这是正确的!Maven需要检查pom.xml中定义的每个工件(及其依赖项)和您定义的每个Repository，因为更新的版本可能在任何这些存储库中可用。

亲自尝试一下，您会感受到缓慢构建的痛苦。

放置工件的最佳位置是Maven Central，因为它是jar的中心位置，这意味着你的构建只会检查一个位置。

你可以在Maven的文档知识库简介中阅读更多关于存储库的信息

作为一种替代方案，Bintray提供了maven存储库的免费托管。如果你绝对不想重命名groupId，这可能是Sonatype OSS和Maven Central的一个很好的替代方案。但是，请至少努力将您的更改集成到上游，或者重命名并发布到Central。这样别人用你的叉子就方便多了。

你可以使用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版本。

好处是您不必处理部署和上传。因为您不想维护自己的工件存储库，所以它很适合您的需求。

如果你只有aar或jar文件本身，或者只是不想使用插件-我已经创建了一个简单的shell脚本。你可以用它来实现同样的目的——将你的工件发布到Github，并将其用作公共Maven repo。

自2019年以来，你现在可以使用名为Github包注册表的新功能。

基本上这个过程是:

• 从github设置生成一个新的个人访问令牌
• 在settings.xml中添加存储库和令牌信息
• < p >部署使用

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

我想添加另一个替代方案，一个我最近一直在工作的Gradle插件:magik。

基本上，它允许直接在github存储库上发布，作为一个maven存储库。

设置是相当strightforward，有一个很好的免费层，这将为我在可预见的未来服务，并有额外的(付费)升级，这在未来很可能会派上用场。

到目前为止，我确实非常满意!