在 github 上托管 Maven 存储库

Question

我有一个在 github 上工作的小型开源库的分支。我想通过 maven 将它提供给其他开发人员，但我不想运行我自己的 Nexus 服务器，而且因为它是一个分支，所以我不能轻易地将它部署到 oss.sonatype.org。

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

Answer 1

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

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 存储库的典型方式是使用 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-plugin 提示输入密码而不是在配置文件中要求它，让我知道。）

然后通过将以下内容添加到您的 pom 中，告诉 GitHub site-maven-plugin 您刚刚配置的新服务器：

<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 将文件“上传”到目标目录中的本地暂存存储库，然后 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 的 pom 以了解您的存储库在哪里。将以下 sn-p 添加到依赖于您的项目的任何项目的 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 存储库下载它们。

编辑：为避免 cmets 中提到的问题（“创建提交时出错：请求无效。对于“属性/名称”，nil 不是字符串。”），请确保在 github 上的个人资料中声明名称。

Answer 2

不要将 GitHub 用作 Maven 存储库。

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

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

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

替代方案 - 维护自己的 Fork

由于您已经 fork 一个开源库，并且您的 fork 也是开源的，因此您可以将您的 fork 上传到 Maven Central（阅读 Guide to uploading artifacts to the Central Repository），方法是给它一个新的 groupId 或者一个新的 artifactId。

仅当您愿意在更改合并到原始项目中之前维护此分叉时才考虑此选项，然后您应该放弃此选项。

认真考虑分叉是否是正确的选择。阅读'why not to fork' 的无数 Google 搜索结果

推理

用 jars 膨胀你的存储库会增加下载大小而没有任何好处

jar 是您项目的 output，它可以随时从其 inputs 重新生成，并且您的 GitHub 存储库应仅包含 inputs。

不相信我？然后检查 'dont store binaries in git' 的 Google 结果。

GitHub's help Working with large files 会告诉你同样的事情。诚然，jar 并不大，但它们比源代码大，一旦某个版本创建了一个 jar，它们就没有理由进行版本控制——这就是新版本的用途。

在您的 pom.xml 中定义多个存储库会使您的构建速度减慢存储库数量乘以工件数量

斯蒂芬康诺利says：

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

没错！ Maven 需要根据您定义的每个存储库检查 pom.xml 中定义的每个工件（及其依赖项），因为任何这些存储库中都可能提供更新的版本。

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

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

您可以在Introduction to Repositories 上的 Maven 文档中阅读更多关于存储库的信息

Answer 3

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

1. 添加存储库：

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

1. 添加依赖：

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

elsewhere 的回答是，JitPack 将构建您的 GitHub 存储库并提供 jars。要求是您有一个构建文件和一个 GitHub 版本。

好处是您不必处理部署和上传。由于您不想维护自己的工件存储库，因此它非常适合您的需求。

Answer 4

自 2019 年起，您现在可以使用名为 Github package registry 的新功能。

基本上流程是：

• 从 github 设置生成新的个人访问令牌
• 在您的settings.xml 中添加存储库和令牌信息

• 部署使用

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

Answer 5

另一种选择是使用任何支持 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 设置

Answer 6

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

Answer 7

如果您只有 aar 或 jar 文件本身，或者只是不想使用插件 - 我已经创建了 a simple shell script。您可以使用它来实现相同的目标 - 将您的工件发布到 Github 并将其用作公共 Maven 存储库。

Answer 8

我想添加另一个替代方案，我最近一直在研究的 Gradle 插件：magik。

基本上它允许直接在充当 maven 存储库的 github 存储库上发布。

Answer 9

我来这里是为了做同样的事情，免费托管我的 Maven 存储库，但经过更多研究后，我最终来到了这里： https://jfrog.com/start-free/

设置是quite strightforward，有一个很好的免费套餐，可以在可预见的未来为我服务，还有额外的（付费的）升级，将来很可能会派上用场。

到目前为止，我确实很高兴！