在github上托管Maven存储库

Question

我有一个小型开源图书馆的分叉，我正在github上工作。我想通过maven让其他开发人员可以使用它，但是我不想运行我自己的Nexus服务器，因为它是一个分叉，所以我不能轻松地将它部署到oss.sonatype.org.

我想做的是将它部署到github，这样其他人就可以使用maven访问它。最好的方法是什么？

Answer 1

您可以使用JitPack（公共Git存储库免费）将您的GitHub存储库公开为Maven工件。它非常容易。您的用户需要将此添加到他们的pom.xml：

1. 添加仓库：

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

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

正如其他地方所回答的，这个想法是JitPack将构建您的GitHub repo，并为jar服务。要求是您有一个构建文件和一个GitHub版本。

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

Answer 2

不要将GitHub用作Maven存储库。

编辑：此选项会获得很多反对票，但没有关于原因的评论。无论实际在GitHub上托管的技术能力如何，这都是正确的选项。基于下面列出的所有原因，在GitHub上托管是错误的，如果没有评论，我无法改进答案以澄清您的问题。

最佳选择-与原始项目协作

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

备选方案-维护自己的叉子

因为您已经创建了一个开源库，而且您的fork也是开源的，所以您可以通过给它一个新的groupId和一个新的artifactId将您的fork上传到Maven Central（阅读将工件上传到中央存储库的指南）。

只有考虑这个选项，如果您愿意维护这个叉，直到更改合并到原来的项目，然后你应该放弃这一个。

真的很难考虑叉子是否是正确的选择。阅读无数谷歌搜索结果“为什么不分叉”

推理

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

jar是您项目的一个输出，它可以随时从它的输入中重新生成，并且您的GitHub回购应该只包含输入。

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

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

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

斯蒂芬·康诺利说：

如果有人添加您的repo，他们会影响他们的构建性能，因为他们现在有另一个repo来检查工件。。。这不是一个大问题，如果你只需要添加一个回购。。。但是问题越来越严重，你知道你的maven构建的下一件事是为每个工件检查50个repo，构建时间是一只狗。

那就对了！Maven需要对照您定义的每个存储库检查pom.xml中定义的每个工件（及其依赖项），因为新版本可能在任何存储库中可用。

你自己试试看，你会感觉到缓慢构建的痛苦。

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

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

Answer 3

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

1. 创建一个名为mvn repo的分支来托管maven工件。

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

• Maven工件在一个名为mvn repo的单独分支中与源代码分开保存，就像github页面在名为gh页面的单独分支中保存一样（如果使用github页面）

将构件部署到远程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，以便githubsite-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插件提示输入密码，而不是在配置文件中要求输入密码，请告诉我。）

然后告诉GitHubsite-maven-plugin关于您刚刚配置的新服务器，通过在您的pom中添加以下内容：

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

最后，配置site maven插件，将临时暂存repo上传到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回购分支不需要存在，它将为您创建。

现在再次运行mvn清洁部署。您应该会看到maven-部署插件将文件“上传到”目标目录中的本地暂存存储库，然后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分支，并验证所有二进制文件都已存在。

恭喜！

现在，只需运行mvncleandeploy，就可以将maven工件部署到穷人的公共repo。

您还需要采取一个步骤，即配置任何依赖于您的pom的pom，以了解您的存储库在哪里。将以下片段添加到任何项目的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上的配置文件中声明名称。