乐趣区

关于java:使用CICD工具Github-Action发布jar到Maven中央仓库

jiezi

之前公布开源我的项目 Payment Spring Boot 到 Maven 地方仓库我都是手动执行 mvn deploy，在CI/CD 大行其道的明天应用这种形式有点“原始”。于是我始终在寻求一种可能反对流水线作业的公布工具，能让我在进行合并代码时主动触发构建公布。有一款收费的产品能做到这一点，它就是Github Action。

Github Action

Github Action是由 Github 创立的 CI/CD 服务。它的目标是使所有软件开发工作流程的自动化变得容易。间接从 GitHub 构建，测试和部署代码。CI（继续集成）由很多操作组成，比方代码合并、运行测试、登录近程服务器，公布到第三方服务等等。

明天我就尝试用 Github Action 来将 Payment Spring Boot 公布到 Maven 地方仓库。

冀望成果

当代码库公布 Release(发行版) 的时候触发一个将 Release 所蕴含的分支公布到 Maven 地方仓库的成果。

拓展浏览：

Release（发行版）是具备 Changelogs（变更日志）和二进制文件的一级对象，能够代表超出 Git 架构自身的一个特定工夫点之前的所有我的项目历史。

前提条件

对于我的项目如何公布到 Maven 地方仓库及其一些必要的条件这里不再探讨，网上有很多教程，有趣味的能够去搜寻一下。也能够参考 Payment Spring Boot 的pom.xml。这里只说一些要害的点，您须要：

  • OSSRH 账号。
  • GPG 密钥信息。

💡留神：这两个都是敏感数据不要泄露给其他人，否则你的我的项目将可能被其他人掌控。

Github Action Secrets

为了从 Github Action 公布，咱们须要让 Github Action 能够应用咱们的 GPG 私钥和 OSSRH 用户信息。为了保障这些敏感信息的安全性，咱们能够应用 Github Action Secrets 来存储它们。

GPG 的细节补充

这里的 GPG_PASSWORD为 GPG 的 Passphrase, 网上 Maven 地方仓库教程必定会提这个，这里不再细说。须要留神的是公钥肯定要上传公钥服务器。

GPG_SECRET 获取步骤如下：

  • 确定你有 GPG 环境，并依照其它教程配置好了 GPG 密钥对。
  • 执行 gpg --list-secret-keys 查看 Key 列表并复制 你须要用的 ID
[root@192 ~]# gpg --list-secret-keys
/root/.gnupg/pubring.kbx
------------------------
sec   rsa2048 2020-07-27 [SC]
      8AC0AB86C34ADC6ED110A5A9E6730F4374866065
uid           felord (felord) <dax@felord.cn>
  • 执行 gpg -a --export-secret-keys KEY_ID(KEY_ID 为上图中以 8AC0AB 结尾的字符串)导出私钥，这里须要输出爱护私钥的明码（GPG_PASSWORD）。而后会呈现以下的密文：
-----BEGIN PGP PRIVATE KEY BLOCK----
............ 密文区域.............
-----END PGP PRIVATE KEY BLOCK-----

这就是`GPG_SECRET `。

批改我的项目的 POM

而后批改我的项目的 pom.xml 文件，模板我曾经提出来了，不能批改的中央我曾经写了正文：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <groupId>cn.felord</groupId>
    <artifactId>payment-spring-boot</artifactId>
    <version>1.0.9.RELEASE</version>
    <packaging>pom</packaging>
    <modelVersion>4.0.0</modelVersion>

    <name>payment-spring-boot</name>
    <description>wechat-pay and alipay sdk</description>
    <url>https://github.com/NotFound403/payment-spring-boot</url>

    <licenses>
        <license>
            <name>Apache License, Version 2.0</name>
            <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
            <distribution>repo</distribution>
            <comments>A business-friendly OSS license</comments>
        </license>
    </licenses>

    <developers>
        <developer>
            <name>felord</name>
            <email>felord@qq.com</email>
            <organization>felord.cn</organization>
        </developer>
    </developers>

    <scm>
        <tag>payment-spring-boot-1.0.9.RELEASE</tag>
        <url>https://github.com/NotFound403/payment-spring-boot</url>
        <connection>scm:git:https://github.com/NotFound403/payment-spring-boot.git</connection>
        <developerConnection>scm:git:https://github.com/NotFound403/payment-spring-boot.git</developerConnection>
    </scm>

    <profiles>
        <!-- Deployment profile (required so these plugins are only used when deploying) -->
         <!-- 上面这个标签里的不能改 -->
        <profile>
            <id>deploy</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-source-plugin</artifactId>
                    </plugin>
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-javadoc-plugin</artifactId>
                    </plugin>
                    <!-- GPG plugin -->
                    <plugin>
                        <groupId>org.apache.maven.plugins</groupId>
                        <artifactId>maven-gpg-plugin</artifactId>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

    <modules>
        <module>payment-spring-boot-autoconfigure</module>
        <module>payment-spring-boot-starter</module>
    </modules>

    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-boot.version>2.4.2</spring-boot.version>
        <aliy-pay-sdk.version>4.10.167.ALL</aliy-pay-sdk.version>
        <oss-starter.version>1.0.0.RELEASE</oss-starter.version>
        <lombok.verison>1.18.12</lombok.verison>
        <jackson.version>2.9.10</jackson.version>
        <bcprov.version>1.66</bcprov.version>
        <jackson.version>2.11.4</jackson.version>
        <httpclient.version>4.5.13</httpclient.version>
    </properties>

    <!-- 上面这个标签里的不能改 -->
    <distributionManagement>
        <repository>
            <id>ossrh</id>
            <name>Nexus Release Repository</name>
            <url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
        </repository>
        <snapshotRepository>
            <id>sonatype-nexus-snapshots</id>
            <name>Nexus Snapshot Repository</name>
            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        </snapshotRepository>
    </distributionManagement>

    <dependencyManagement>
        <dependencies>
            <!-- 你我的项目的依赖写这里 -->
        </dependencies>
    </dependencyManagement>
         <!-- 上面这个标签里的不能改 -->
    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-source-plugin</artifactId>
                    <version>3.1.0</version>
                    <executions>
                        <execution>
                            <phase>package</phase>
                            <goals>
                                <goal>jar-no-fork</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-javadoc-plugin</artifactId>
                    <version>3.2.0</version>
                    <configuration>
                        <show>private</show>
                        <nohelp>true</nohelp>
                        <charset>UTF-8</charset>
                        <encoding>UTF-8</encoding>
                        <docencoding>UTF-8</docencoding>
                    </configuration>
                    <executions>
                        <execution>
                            <phase>compile</phase>
                            <goals>
                                <goal>jar</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-gpg-plugin</artifactId>
                    <version>1.6</version>
                    <executions>
                        <execution>
                            <id>sign-artifacts</id>
                            <phase>verify</phase>
                            <goals>
                                <goal>sign</goal>
                            </goals>
                            <configuration>
                                <!-- Prevent `gpg` from using pinentry programs -->
                                <gpgArguments>
                                    <arg>--pinentry-mode</arg>
                                    <arg>loopback</arg>
                                </gpgArguments>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
                <plugin>
                    <groupId>org.sonatype.plugins</groupId>
                    <artifactId>nexus-staging-maven-plugin</artifactId>
                    <version>1.6.8</version>
                    <extensions>true</extensions>
                    <configuration>
                        <serverId>ossrh</serverId>
                        <nexusUrl>https://oss.sonatype.org/</nexusUrl>
                        <autoReleaseAfterClose>false</autoReleaseAfterClose>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.sonatype.plugins</groupId>
                <artifactId>nexus-staging-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

联合你本人的我的项目进行必要的填充。

编写 Github Action 脚本

Github Action脚本保留在我的项目根目录下的 .github/workflows 门路中。咱们只须要编写一个 yaml 来申明执行的步骤即可，具体的语法能够去看相干的中文文档，这里只列出公布到 Maven 地方仓库的 action 脚本：

# 相当于脚本用处的一个申明
name: Maven Central Repo Deployment
# 触发脚本的事件  这里为公布 release 之后触发
on:
  release:
    types: [released]
# 定义一个发行工作
jobs:
  publish:
# 工作运行的环境
    runs-on: ubuntu-latest
# 工作的步骤
    steps:
# 1. 申明 checkout 仓库代码到工作区
      - name: Checkout Git Repo
        uses: actions/checkout@v2
# 2. 装置 Java 环境 这里会用到的参数就是 Git Action secrets 中配置的，#    取值要在 key 后面加  secrets.
      - name: Set up Maven Central Repo
        uses: actions/setup-java@v1
        with:
          java-version: 1.8
          server-id: sonatype-nexus-staging
          server-username: ${{secrets.OSSRH_USER}}
          server-password: ${{secrets.OSSRH_PASSWORD}}
          gpg-passphrase:  ${{secrets.GPG_PASSWORD}}
# 3. 公布到 Maven 地方仓库
      - name: Publish to Maven Central Repo
# 这里用到了其他人写的 action 脚本，具体能够去看他的文档。uses: samuelmeuli/action-maven-publish@v1
        with:
          gpg_private_key: ${{secrets.GPG_SECRET}}
          gpg_passphrase: ${{secrets.GPG_PASSWORD}}
          nexus_username: ${{secrets.OSSRH_USER}}
          nexus_password: ${{secrets.OSSRH_PASSWORD}}

触发 Action

都筹备结束后，action 脚本要提交到 Github，当你应用release 性能后会主动在 action 一栏中执行整个公布流程：

这种形式一次配置，到处公布。咱们不须要再关怀怎么公布了，只须要关怀在什么时候公布。

能够参考 Payment Spring Boot我的项目。

总结

明天通过对 Github Action 的简略应用来介绍了 CI/CD 的作用，这个技术体系是我的项目集成交付的趋势，也是面试中的一个亮点技能。而且这种形式能够实现“一次配置，随时随地集成部署”。

关注公众号：Felordcn 获取更多资讯

集体博客：https://felord.cn

退出移动版