如何从 GitHub Package Registry (Beta) 访问 maven 依赖项

Question

我将一个 maven artefact 上传到 GitHub Package Registry (Beta) 并希望将其添加为 maven 依赖项。我已经在Regestry-Beta 中并为我的示例HalloMaven 项目激活了它。 mvn deploy 也成功了，所以工件是 public 在此处可用： https://github.com/TobseF/HelloMaven/packages
但是如何将其包含为 maven 依赖项？

我尝试使用 pom.xml 将其添加到一个新的示例项目中：

<groupId>de.tfr.test</groupId>
<artifactId>maven-repo-test</artifactId>
<version>1.0-SNAPSHOT</version>

<repositories>
    <repository>
        <id>github</id>
        <name>GitHub TobseF Apache Maven Packages</name>
        <url>https://github.com/TobseF/HelloMaven/packages</url>
        <!-- also tried:
        <url>https://maven.pkg.github.com/HelloMaven/</url> -->
    </repository>
</repositories>


<dependencies>
    <dependency>
        <groupId>github.tobsef</groupId>
        <artifactId>hello-maven</artifactId>
        <version>1.2.1</version>
    </dependency>
</dependencies>

但是无法解决依赖关系。 奇怪的是artifactId是github.tobsef.hello-maven，和pom中指定的hello-maven不匹配。但我不知道为什么 github.tobsef 会在前面加上存储库 url 是否正确。

官方 GitHub Configuring Apache Maven for use with GitHub Package Registry 仅显示如何使用凭据推送。但我的仓库是公开的，不需要身份验证。

HalloMaven 示例的设置：

settings.xml

    <profiles>
        <profile>
            <id>github</id>
            <repositories>
                <repository>
                    <id>github</id>
                    <name>GitHub TobseF Apache Maven Packages</name>
                    <url>https://maven.pkg.github.com/TobseF</url>
                </repository>
            </repositories>
        </profile>
    </profiles>

    <servers>
        <server>
            <id>github</id>
            <username>${env.GITHUB_USERNAME}</username>
            <password>${env.GITHUB_TOKEN}</password>
        </server>
    </servers>

pom.xml

   <groupId>github.tobsef</groupId>
    <artifactId>hello-maven</artifactId>
    <version>1.2.1</version>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <artifactId>maven-deploy-plugin</artifactId>
                <version>2.8.1</version>
            </plugin>
        </plugins>
    </build>

    <properties>
        <github.global.server>github</github.global.server>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>11</java.version>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>

    <distributionManagement>
        <repository>
            <id>github</id>
            <name>GitHub TobseF Apache Maven Packages</name>
            <url>https://maven.pkg.github.com/TobseF/HelloMaven</url>
        </repository>
    </distributionManagement>

deploy.yml

name: Maven Deploy

on:
  push:
    branches:
      - master

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v1
      - name: Set up JDK 11
        uses: actions/setup-java@v1
        with:
          java-version: 11
      - name: Maven build
        run: mvn --file pom.xml package

  deploy:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
    - name: Set up JDK 11
      uses: actions/setup-java@v1
      with:
        java-version: 11
    - name: Deploy to Github Package Registry
      env:
        GITHUB_USERNAME: ${{ secrets.GITHUB_USERNAME }}
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: mvn --settings settings.xml --file pom.xml deploy

结果是Could not find artifact github.tobsef:hello-maven:pom:1.2.1 in github (https://github.com/TobseF/HelloMaven/packages)。

任何想法如何设置部署以部署正确的工件以及如何将其添加为依赖项？

Answer 1

好的✅，我发现了如何正确配置它。

您可以在此处查看带有工作 GitHub Actions CI 和 GitHub Package Registry 的示例项目：
?HelloMaven
要查看如何包含依赖项，请查看：
?GitHub-plugin-registry-example Template

诀窍是在全局 maven settings.xml 中向 GitHub API 添加身份验证。

<servers>
    <server>
        <id>github</id>
        <username>YOUR_USERNAME</username>
        <password>YOUR_AUTH_TOKEN</password>
    </server>
</servers>

将 YOUR_USERNAME 替换为您的 GitHub 登录名。
将 YOUR_AUTH_TOKEN 替换为生成的 GitHub 个人访问令牌：
GitHub > 设置 > 开发者设置 > 个人访问令牌 > 生成新令牌:
令牌至少需要read:packages 范围。 否则你会得到一个Not authorized 异常。

不清楚是否也需要此身份验证才能读取包。特别是因为该 jar 在包页面上无需任何登录即可使用： https://github.com/TobseF/HelloMaven/packages

所以这有点讨厌，因为我们必须添加<server><id>github</id>...，并希望其他人也将repository 提供github id。否则，我们必须为每个 github 依赖项添加服务器配置。

请记住，每个 GitHub 存储库都是它自己的 maven 存储库。所以没有像 maven Central 这样的全局注册表。每个依赖项都必须提供自己的 repository 链接声明。

但结合 GitHub Actions CI，它是一个非常好的选择，无需任何第三方插件。