我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

Configuring Apache Maven for use with GitHub Packages

You can configure Apache Maven to publish packages to GitHub 包注册表 and to use packages stored on GitHub 包注册表 as dependencies in a Java project.

GitHub 包注册表 is available with GitHub Free, GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. 更多信息请参阅“GitHub 的产品。”

In this article

Authenticating to GitHub 包注册表

You need an access token to publish, install, and delete packages in GitHub 包注册表. You can use a personal access token to authenticate with your username directly to GitHub 包注册表 or the GitHub API. You can use a GITHUB_TOKEN to authenticate using a GitHub 操作 workflow.

Authenticating with a personal access token

You must use a personal access token with the appropriate scopes to publish and install packages in GitHub 包注册表. For more information, see "About GitHub 包注册表."

You can authenticate to GitHub 包注册表 with Apache Maven by editing your ~/.m2/settings.xml file to include your personal access token. Create a new ~/.m2/settings.xml file if one doesn't exist.

In the servers tag, add a child server tag with an id, replacing USERNAME with your GitHub username, and TOKEN with your personal access token.

In the repositories tag, configure a repository by mapping the id of the repository to the id you added in the server tag containing your credentials. Replace REPOSITORY with the name of the repository you'd like to publish a package to or install a package from, and OWNER with the name of the user or organization account that owns the repository. 由于不支持大写字母,因此,即使您的 GitHub 用户或组织名称中包含大写字母,也必须对仓库所有者使用小写字母。

If you want to interact with multiple repositories, you can add each repository to separate repository children in the repositories tag, mapping the id of each to the credentials in the servers tag.

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">

  <activeProfiles>
    <activeProfile>github</activeProfile>
  </activeProfiles>

  <profiles>
    <profile>
      <id>github</id>
      <repositories>
        <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2</url>
          <releases><enabled>true</enabled></releases>
          <snapshots><enabled>false</enabled></snapshots>
        </repository>
        <repository>
          <id>github</id>
          <name>GitHub OWNER Apache Maven Packages</name>
          <url>https://maven.pkg.github.com/OWNER/REPOSITORY</url>
        </repository>
      </repositories>
    </profile>
  </profiles>

  <servers>
    <server>
      <id>github</id>
      <username>USERNAME</username>
      <password>TOKEN</password>
    </server>
  </servers>
</settings>

Note: GitHub 包注册表 does not support SNAPSHOT versions of Apache Maven. Make sure you disable SNAPHOT in your ~/.m2/settings.xml file.

Authenticating with the GITHUB_TOKEN

您也可以在 GitHub 操作 工作流程的 GitHub 包注册表 中使用 GITHUB_TOKEN 发布并使用包,而无需存储和管理个人访问令牌。有关 GITHUB_TOKEN 的更多信息,请参阅“GITHUB_TOKEN 密码”。

您可以使用脚本将 GITHUB_TOKEN 注入的 GitHub 包注册表 的适当配置文件。在包客户端的配置文件中将 GitHub 包注册表 添加为替代注册表或仓库,以及具有适当范围的 GitHub 用户名和个人访问令牌。创建配置文件的准确步骤因包类型而异。

Publishing a package

By default, GitHub uses the package name to create a repository where the package will be published. For example, GitHub will publish a package named com.example.test in a repository called OWNER/test.

If you would like to publish multiple packages to the same repository, you can include the URL of the repository in the <scm> element of the pom.xml file. GitHub will match the repository based on that field. Since the repository name is also part of the distributionManagement element, there are no additional steps to publish multiple packages to the same repository.

For more information on creating a package, see the maven.apache.org documentation.

  1. Edit the distributionManagement element of the pom.xml file located in your package directory, replacing OWNER with the name of the user or organization account that owns the repository and REPOSITORY with the name of the repository containing your project.

    <distributionManagement>
       <repository>
         <id>github</id>
         <name>GitHub OWNER Apache Maven Packages</name>
         <url>https://maven.pkg.github.com/OWNER/REPOSITORY</url>
       </repository>
    </distributionManagement>
  2. Publish the package.

    $ mvn deploy

After you publish a package, you can view the package on GitHub. For more information, see “Viewing a repository's packages.”

Installing a package

To install an Apache Maven package from GitHub 包注册表, edit the pom.xml file to include the package as a dependency. If you want to install packages from more than one repository, add a repository tag for each. For more information on using a pom.xml file in your project, see "Introduction to the POM" in the Apache Maven documentation.

  1. Authenticate to GitHub 包注册表. For more information, see "Authenticating to GitHub 包注册表."

  2. Add the package dependencies to the dependencies element of your project pom.xml file, replacing com.example.test with your package.

    <dependencies>
      <dependency>
        <groupId>com.example</groupId>
        <artifactId>test</artifactId>
        <version>1.0.0</version>
      </dependency>
    </dependencies>
  3. Install the package.

    $ mvn install

Further reading

问问别人

找不到要找的内容?

联系我们