在github上托管Maven存储库

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

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

回答(6)

3 years ago

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

  • 创建一个名为 mvn-repo 的分支来托管您的maven工件 .

  • 使用github site-maven-plugin将工件推送到github .

  • 配置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提示输入密码而不是在配置文件中要求,请告诉我 . )

然后通过将以下内容添加到您的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 "upload"文件到目标目录中的本地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 分支,并验证所有二进制文件现在都在那里 .

enter image description here

Congratulations!

现在,您只需运行 mvn clean deploy 即可将maven工件部署到穷人的公共存储库中 .

您还需要采取一个步骤,即配置依赖于您的pom的任何pom,以了解您的存储库的位置 . 将以下代码段添加到依赖于项目的任何项目的pom中:

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

现在任何需要你的jar文件的项目都会自动从你的github maven存储库下载它们 .

编辑:避免注释中提到的问题('创建提交错误:无效请求 . 对于'属性/名称',nil不是字符串 . '),请确保在github上的配置文件中声明了一个名称 .

3 years ago

Don't use GitHub as a Maven Repository.

编辑:此选项获得了大量的投票,但没有评论为什么 . 无论在GitHub上实际托管的技术能力如何,这都是正确的选择 . 由于下面列出的所有原因而在GitHub上托管是错误的,如果没有评论,我无法改进答案以澄清您的问题 .

Best Option - Collaborate with the Original Project

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

Alternative - Maintain your own Fork

既然你已经分叉了一个开源库,并且你的fork也是开源的,你可以通过给它一个新的 groupId 和一个新的 artifactId 将你的fork上传到Maven Central(阅读Guide to uploading artifacts to the Central Repository) .

如果您愿意维护此分支,直到将更改合并到原始项目中,然后您应该放弃这个选项,则只考虑此选项 .

真的很难认为叉子是否是正确的选择 . 阅读'why not to fork'的无数谷歌搜索结果

Reasoning

Bloating your repository with jars increases download size for no benefit

jar是项目的 output ,它可以随时从 inputs 重新生成,而你的GitHub仓库应该只包含 inputs .

不相信我?然后查看Google搜索结果'dont store binaries in git' .

GitHub's help Working with large files会告诉你同样的事情 . 不可否认,jar大于但它们比源代码更大,一旦发布了一个jar,他们没有理由进行版本控制 - 这就是新版本的用途 .

Defining multiple repos in your pom.xml slows your build down by Number of Repositories times Number of Artifacts

Stephen Connolly says

如果有人添加你的仓库,他们会影响他们的构建性能,因为他们现在有另一个仓库来检查工件...如果你只需要添加一个仓库,这不是一个大问题......但是问题在增加,接下来你知道了你的maven构建每个都要检查50个回购神器和建造时间是一条狗 .

那就对了! Maven needs to check every artifact (and its dependencies) defined in your pom.xml against every Repository you have defined ,因为任何这些存储库中都可以使用较新的版本 .

为自己尝试一下,你会感受到缓慢构建的痛苦 .

文物的最佳位置是Maven Central,因为它是 jar 的中心位置,这意味着你的构建只会检查 one 位置 .

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

3 years ago

您可以使用JitPack将GitHub存储库公开为Maven工件 . 它很容易 . 您的用户需要将其添加到他们的pom.xml:

  • 添加存储库:
<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>

正如回答elsewhere的想法是,JitPack将构建您的GitHub仓库并将为 jar 服务 . 要求是您有一个构建文件和一个GitHub版本 .

好消息是您不必处理部署和上传 . 由于您不想维护自己的工件库,因此可以很好地满足您的需求 .

3 years ago

另一种方法是使用任何支持webdav的Web托管 . 当然,你需要一些空间,但它很容易设置,也是运行一个完整的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功能 .

优点:您拥有自己的maven存储库缺点:您在nexus中没有任何管理功能;你需要在某处设置一些webdav

3 years ago

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

3 years ago

如果您自己只有 aarjar 文件,或者只是't want to use plugins - I' ve创建了a simple shell script . 您可以实现相同的功能 - 将您的工件发布到Github并将其用作公共Maven仓库 .