使用 Maven 发布 Java 包

Note

GitHub Enterprise Server 目前不支持 GitHub 托管的运行器。可以在 GitHub public roadmap 上查看有关未来支持计划的更多信息。

简介

本指南介绍如何创建将 Java 包发布到 GitHub Packages 和 Maven Central 仓库的工作流程。通过单个工作流程，您可以将包发布到一个或多个仓库。

Warning

本指南中使用的示例指旧版 OSSRH 服务。请参阅 Maven 中央存储库文档中“发布”。

先决条件

建议对工作流程文件和配置选项有一个基本了解。有关详细信息，请参阅“写入工作流”。

有关使用 Maven 为 Java 项目创建 CI 工作流的详细信息，请参阅“使用 Maven 构建和测试 Java”。

你可能还发现基本了解以下内容是有帮助的：

关于包配置

pom.xml 文件中的 groupId 和 artifactId 字段为包创建唯一标识符，注册表使用该标识符将包链接到注册表。有关详细信息，请参阅 Apache Maven 文档中的将项目上传到中央存储库的指南。

pom.xml 文件还包含 Maven 将在其中部署包的分发管理存储库的配置。每个仓库都必须有名称和部署 URL。可在运行 Maven 的用户主目录中的 .m2/settings.xml 文件中配置这些存储库的身份验证。

可以使用 setup-java 操作配置部署存储库以及该存储库的身份验证。有关详细信息，请参阅 setup-java。

将包发布到 Maven 中心仓库

每次创建新版本时，都可以触发工作流程来发布包。以下示例中的工作流在类型为 created 的 release 事件触发时运行。如果 CI 测试通过，工作流程将包发布到 Maven 中心仓库。有关 release 事件的详细信息，请参阅“触发工作流的事件”。

在此工作流中，可以使用 setup-java 操作。此操作将给定版本的 JDK 安装到 PATH 中，但同时会配置 Maven settings.xml 以发布包。默认情况下，设置文件将配置用于 GitHub Packages，但可以将其配置为部署到另一个包注册表，如 Maven 中心仓库。如果已在 pom.xml 中配置了分发管理存储库，则可在 setup-java 操作调用期间指定该 id。

例如，如果通过 OSSRH 托管项目部署到 Maven 中央存储库，则 pom.xml 可以指定 id 为 ossrh 的分发管理存储库。

XML

<project ...>
  ...
  <distributionManagement>
    <repository>
      <id>ossrh</id>
      <name>Central Repository OSSRH</name>
      <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
    </repository>
  </distributionManagement>
</project>

<project ...>
  ...
  <distributionManagement>
    <repository>
      <id>ossrh</id>
      <name>Central Repository OSSRH</name>
      <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
    </repository>
  </distributionManagement>
</project>

使用此配置，可通过将存储库管理 id 指定到 setup-java 操作，创建一个将包发布到 Maven 中央存储库的工作流。您还需要提供包含用户名和密码的环境变量向仓库验证。

在部署步骤中，您需要将环境变量设置为向仓库验证的用户名，以及用密码或令牌配置为进行身份验证的密钥。有关详细信息，请参阅“在 GitHub Actions 中使用机密”。

YAML

name: Publish package to the Maven Central Repository
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Maven Central Repository
        uses: actions/setup-java@v4
        with:
          java-version: '11'
          distribution: 'temurin'
          server-id: ossrh
          server-username: MAVEN_USERNAME
          server-password: MAVEN_PASSWORD
      - name: Publish package
        run: mvn --batch-mode deploy
        env:
          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}

name: Publish package to the Maven Central Repository
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Maven Central Repository
        uses: actions/setup-java@v4
        with:
          java-version: '11'
          distribution: 'temurin'
          server-id: ossrh
          server-username: MAVEN_USERNAME
          server-password: MAVEN_PASSWORD
      - name: Publish package
        run: mvn --batch-mode deploy
        env:
          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}

此工作流程执行以下步骤：

检出项目仓库的副本。
设置 Java JDK，并使用 MAVEN_USERNAME 和 MAVEN_PASSWORD 环境变量配置 Maven settings.xml 文件，为 ossrh 存储库添加身份验证。
运行 mvn --batch-mode deploy 命令以发布到 ossrh 存储库。 MAVEN_USERNAME 环境变量将使用 OSSRH_USERNAME 机密的内容进行设置，MAVEN_PASSWORD 环境变量将使用 OSSRH_TOKEN 机密的内容进行设置。

有关在工作流中使用机密的详细信息，请参阅“在 GitHub Actions 中使用机密”。

发布包到 GitHub Packages

每次创建新版本时，都可以触发工作流程来发布包。以下示例中的工作流在类型为 created 的 release 事件触发时运行。如果 CI 测试通过，工作流程会将包发布到 GitHub Packages。有关 release 事件的详细信息，请参阅“触发工作流的事件”。

在此工作流中，可以使用 setup-java 操作。此操作将给定版本的 JDK 安装到 PATH 中，并设置 Maven settings.xml 以将包发布到 GitHub Packages。生成的 settings.xml 为服务器定义身份验证，该服务器的 id 为 github，使用 GITHUB_ACTOR 环境变量作为用户名，使用 GITHUB_TOKEN 环境变量作为密码。 GITHUB_TOKEN 环境变量被分配了特殊 GITHUB_TOKEN 机密的值。

每当工作流中的作业开始时，GITHUB_TOKEN 机密都会设置为存储库的访问令牌。应在工作流文件中设置此访问令牌的权限，以授予 contents 权限的读取访问权限，并授予 packages 权限的写入访问权限。有关详细信息，请参阅“自动令牌身份验证”。

对于基于 Maven 的项目，可通过在 pom.xml 文件中创建分发存储库来使用这些设置，该文件的 id 为 github，指向 GitHub Packages 终结点。

例如，如果组织名为“octocat”而存储库名为“hello-world”，则 pom.xml 中的 GitHub Packages 配置将类似于下面的例子。

XML

<project ...>
  ...
  <distributionManagement>
    <repository>
      <id>github</id>
      <name>GitHub Packages</name>
      <url>https://maven.pkg.github.com/octocat/hello-world</url>
    </repository>
  </distributionManagement>
</project>

<project ...>
  ...
  <distributionManagement>
    <repository>
      <id>github</id>
      <name>GitHub Packages</name>
      <url>https://maven.pkg.github.com/octocat/hello-world</url>
    </repository>
  </distributionManagement>
</project>

使用此配置，你可以创建一个工作流，利用自动生成的 settings.xml 将包发布到 GitHub Packages。

YAML

name: Publish package to GitHub Packages
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: '11'
          distribution: 'temurin'
      - name: Publish package
        run: mvn --batch-mode deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

name: Publish package to GitHub Packages
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-java@v4
        with:
          java-version: '11'
          distribution: 'temurin'
      - name: Publish package
        run: mvn --batch-mode deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

此工作流程执行以下步骤：

检出项目仓库的副本。
设置 Java JDK，并自动配置 Maven settings.xml 文件，为 github Maven 存储库添加身份验证以使用 GITHUB_TOKEN 环境变量。
运行 mvn --batch-mode deploy 命令以发布到 GitHub Packages。 GITHUB_TOKEN 环境变量将使用 GITHUB_TOKEN 机密的内容进行设置。 permissions 键指定了对 GITHUB_TOKEN 授予的访问权限。

有关在工作流中使用机密的详细信息，请参阅“在 GitHub Actions 中使用机密”。

发布包到 Maven 中心仓库和 GitHub Packages

可以通过对每个注册表使用 setup-java 操作将包发布到 Maven 中央存储库和 GitHub Packages。

确保 pom.xml 文件包含用于 GitHub 存储库和 Maven 中央存储库提供程序的分发管理存储库。例如，如果通过 OSSRH 托管项目部署到中央存储库，你可以通过将 id 设置为 ossrh 在分发管理存储库中指定该 OSSRH 托管项目，并且可以通过将 id 设置为 github 在分发管理存储库中指定 GitHub Packages。

YAML

name: Publish package to the Maven Central Repository and GitHub Packages
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
    steps:
      - uses: actions/checkout@v4
      - name: Set up Java for publishing to Maven Central Repository
        uses: actions/setup-java@v4
        with:
          java-version: '11'
          distribution: 'temurin'
          server-id: ossrh
          server-username: MAVEN_USERNAME
          server-password: MAVEN_PASSWORD
      - name: Publish to the Maven Central Repository
        run: mvn --batch-mode deploy
        env:
          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
      - name: Set up Java for publishing to GitHub Packages
        uses: actions/setup-java@v4
        with:
          java-version: '11'
          distribution: 'temurin'
      - name: Publish to GitHub Packages
        run: mvn --batch-mode deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

name: Publish package to the Maven Central Repository and GitHub Packages
on:
  release:
    types: [created]
jobs:
  publish:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
    steps:
      - uses: actions/checkout@v4
      - name: Set up Java for publishing to Maven Central Repository
        uses: actions/setup-java@v4
        with:
          java-version: '11'
          distribution: 'temurin'
          server-id: ossrh
          server-username: MAVEN_USERNAME
          server-password: MAVEN_PASSWORD
      - name: Publish to the Maven Central Repository
        run: mvn --batch-mode deploy
        env:
          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
      - name: Set up Java for publishing to GitHub Packages
        uses: actions/setup-java@v4
        with:
          java-version: '11'
          distribution: 'temurin'
      - name: Publish to GitHub Packages
        run: mvn --batch-mode deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

此工作流调用 setup-java 操作两次。每次 setup-java 操作运行时，都会覆盖 Maven settings.xml 文件以发布包。为向存储库进行身份验证，settings.xml 文件引用分发管理存储库 id 以及用户名和密码。

此工作流程执行以下步骤：

检出项目仓库的副本。
第一次调用 setup-java。这将为 ossrh 存储库配置 Maven settings.xml 文件，并将身份验证选项设置为在下一步中定义的环境变量。
运行 mvn --batch-mode deploy 命令以发布到 ossrh 存储库。 MAVEN_USERNAME 环境变量将使用 OSSRH_USERNAME 机密的内容进行设置，MAVEN_PASSWORD 环境变量将使用 OSSRH_TOKEN 机密的内容进行设置。
第二次调用 setup-java。这将自动为 GitHub Packages 配置 Maven settings.xml 文件。
运行 mvn --batch-mode deploy 命令以发布到 GitHub Packages。 GITHUB_TOKEN 环境变量将使用 GITHUB_TOKEN 机密的内容进行设置。 permissions 键指定了对 GITHUB_TOKEN 授予的访问权限。

有关在工作流中使用机密的详细信息，请参阅“在 GitHub Actions 中使用机密”。

使用 Maven 发布 Java 包

本文内容

简介

先决条件

关于包配置

将包发布到 Maven 中心仓库

发布包到 GitHub Packages

发布包到 Maven 中心仓库和 GitHub Packages