通过 GitHub Actions 自动发布项目到 Maven 中央仓库

精选原创

isea533 2022-08-19 20:14:28 博主文章分类：解决问题 ©著作权

文章标签 github github action maven central maven java 文章分类 Spark 大数据

©著作权归作者所有：来自51CTO博客作者isea533的原创作品，请联系作者获取转载授权，否则将追究法律责任

基础的 Maven 配置

参考官方文档：

本文对应的演示项目：

https://github.com/abel533/autodeploy-maven-central

配置 Maven 插件

上面官方文档也有用法。
插件详细文档: https://help.sonatype.com/repomanager2/staging-releases/configuring-your-project-for-deployment

使用 oss 官方推荐的发布插件：

<plugin>
   <groupId>org.sonatype.plugins</groupId>
   <artifactId>nexus-staging-maven-plugin</artifactId>
   <extensions>true</extensions>
   <configuration>
      <serverId>ossrh</serverId>
      <nexusUrl>https://oss.sonatype.org/</nexusUrl>
      <autoReleaseAfterClose>true</autoReleaseAfterClose>
   </configuration>
</plugin>

这里配置的 autoReleaseAfterClose 会自动在 close 后执行 release 发布操作，如果想手工执行，可以去掉这里的配置。

配置 GitHub Actions

添加 .github/workflows/release.yml 文件，内容如下：

name: Publish package to the Maven Central Repository
on:
  push:
    tags: [ "*" ]
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Maven Central Repository
        uses: actions/setup-java@v2
        with:
          java-version: '8'
          distribution: 'adopt'
          server-id: ossrh
          server-username: MAVEN_USERNAME
          server-password: MAVEN_PASSWORD
      - id: install-secret-key
        name: Install gpg secret key
        run: |
          cat <(echo -e "${{ secrets.OSSRH_GPG_SECRET_KEY }}") | gpg --batch --import
          gpg --list-secret-keys --keyid-format LONG
      - name: Publish package
        env:
          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
        run: mvn --batch-mode -Dgpg.passphrase=${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }}

这里的 on.push.tags 意思是当推送一个 tag 时，自动执行发布操作。

在 jobs 的具体配置中，用到了下面几个 Actions secrets 的配置：

OSSRH_USERNAME: oss 用户名
OSSRH_TOKEN: oss 密码
OSSRH_GPG_SECRET_KEY: gpg 签名密钥
OSSRH_GPG_SECRET_KEY_PASSWORD: gpg 签名密码

这几个配置需要在当前项目的 Settings 中配置好。

gpg 密钥导出和导入

基础的配置还参考开头提供的官方文档。
参考: https://gist.github.com/sualeh/ae78dc16123899d7942bc38baba5203c

配置 gpg 插件不提示密码:

<configuration>
  <gpgArguments>
      <arg>--pinentry-mode</arg>
      <arg>loopback</arg>
  </gpgArguments>
</configuration>

查找密钥gpg --list-secret-keys --keyid-format=long
导出密钥gpg --export-secret-keys -a <key-id> > secret.txt，不用按参考中替换换行符，用完整的内容即可。
在脚本中导入cat <(echo -e "${{ secrets.OSSRH_GPG_SECRET_KEY }}") | gpg --batch --import。
在 mvn 命令中，通过-Dgpg.passphrase=${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }} 指定密钥的密码。

效果演示

通过 GitHub Actions 自动发布项目到 Maven 中央仓库_maven central

oss 的 deploy 插件，和正常的相比，增加了 close 和 release 两个操作，对应的日志如下：

[INFO]  * Upload of locally staged artifacts finished.
[INFO]  * Closing staging repository with ID "comgithubabel533-1055".

Waiting for operation to complete...
..............

[INFO] Remote staged 1 repositories, finished with success.
[INFO] Remote staging repositories are being released...

Waiting for operation to complete...
.......

[INFO] Remote staging repositories released.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  02:18 min
[INFO] Finished at: 2022-04-04T23:21:53+08:00
[INFO] ------------------------------------------------------------------------

正常发布后，就能从 oss 查询到构件，其他仓库大概经过几小时才能同步。