开源项目的Maven中央仓库发布指南

后端

2023-11-24 17:51:26

引言

在开源软件开发中，将我们的项目发布到Maven中央仓库是一项至关重要的任务。中央仓库是开发人员可以轻松访问和获取Java库的宝贵资源。通过发布到中央仓库，我们可以提升项目的可见度、可信度和可用性。

先决条件

在开始发布过程之前，确保您已满足以下先决条件：

拥有一个有效的OSS Nexus账户
已注册一个Java Package Name（JPn）
已开发了一个符合Maven标准的JAR包

第1步：创建Nexus Staging仓库

访问OSS Nexus网站并登录。
点击“Staging Repositories”标签。
单击“Create Staging Repository”按钮。
为您的项目输入一个唯一名称并单击“创建”。

第2步：配置Maven设置

打开您的.m2/settings.xml文件。
添加以下内容：

<settings>
  <servers>
    <server>
      <id>ossrh</id>
      <username>你的OSS Nexus用户名</username>
      <password>你的OSS Nexus密码</password>
    </server>
  </servers>
</settings>

第3步：部署JAR包

打开终端或命令提示符。
导航到包含您的JAR包的目录。
执行以下命令：

mvn deploy -DaltDeploymentRepository=ossrh::default::https://s01.oss.sonatype.org/service/local/staging/deploy/maven2

第4步：关闭并发布快照

执行以下命令关闭您的快照：

mvn nexus-staging:close -DaltStagingProfileId=YOUR_STAGING_PROFILE_ID

执行以下命令发布快照：

mvn nexus-staging:release -DaltStagingProfileId=YOUR_STAGING_PROFILE_ID

第5步：等待审核

Sonatype团队将审查您的快照并确保其符合中央仓库的标准。此过程可能需要数小时或数天，具体取决于提交的复杂性。

第6步：发布到中央仓库

一旦快照被批准，Sonatype团队将将其发布到中央仓库。您应该会在Maven中央仓库中看到您的项目。

GitHub Actions集成

为了实现持续集成，我们可以在GitHub Actions中设置一个工作流程。这将自动执行发布过程，节省时间并减少人为错误。

name: Release to Maven Central

on:
  push:
    branches:
      - main

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-java@v3
        with:
          java-version: 17
          distribution: 'adopt'
      - run: mvn deploy -DaltDeploymentRepository=ossrh::default::https://s01.oss.sonatype.org/service/local/staging/deploy/maven2
      - run: mvn nexus-staging:close -DaltStagingProfileId=YOUR_STAGING_PROFILE_ID
      - run: mvn nexus-staging:release -DaltStagingProfileId=YOUR_STAGING_PROFILE_ID