一、github actions 使用#

官方文档：GitHub Actions 文档 - GitHub 文档

官方文档里面将各个功能介绍的很详细，因此这里只讲述基础用法

1.1 基础功能使用#

1.1.1 流水线管理#

在项目中的action中，可以看到所有的流水线

点击具体的流水线，可以进行管理

1.1.2 流水线手动触发#

修改工作流文件，将 on 触发器改为 workflow_dispatch。启用后，工作流页面上会出现一个 Run workflow 按钮，点击即可手动触发

1
name: 构建并上传到 Docker Hub
2
run-name: ${{ github.actor }} 正在打包上传镜像 🚀
3

4
on:
5
  workflow_dispatch:
6

7
jobs:
8
  build:
9
    runs-on: ubuntu-latest
10
    steps:
11
      - name: 检出代码
12
        uses: actions/checkout@v6
13

14
      - name: 设置 JDK 21
15
        uses: actions/setup-java@v4
16
        with:
17
          java-version: '21'
18
          distribution: 'temurin'
19
          cache: maven
20

21
      - name: Maven 打包项目
22
        run: mvn clean package -DskipTests
23

24
      - name: 登录 Docker Hub
25
        uses: docker/login-action@v3
26
        with:
27
          username: ${{ secrets.DOCKER_HUB_USERNAME }}
28
          password: ${{ secrets.DOCKER_HUB_TOKEN }}
29

30
      - name: 构建并推送 Docker 镜像
31
        uses: docker/build-push-action@v6
32
        with:
33
          context: .
34
          push: true
35
          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/java_test:latest

添加成功后，在action中会出现手动触发构建的选项

2.1 action项目示例#

实现流程：

每次push代码到 main 分支，会自动：

用 JDK 21 编译你的 SpringBoot 项目
生成 target/demo-1.0.jar
根据你的 Dockerfile 构建镜像
推送到你的 Docker Hub
之后使用服务器只要拉取镜像运行

2.1.1 github创建项目#

github中创建项目java_test

2.1.1.1 java源码#

src/main/java/com/example路径下创建文件DemoApplication.java

1
package com.example;
2

3
import org.springframework.boot.SpringApplication;
4
import org.springframework.boot.autoconfigure.SpringBootApplication;
5
import org.springframework.web.bind.annotation.GetMapping;
6
import org.springframework.web.bind.annotation.RestController;
7

8
@SpringBootApplication
9
@RestController
10
public class DemoApplication {
11
    public static void main(String[] args) {
12
        SpringApplication.run(DemoApplication.class, args);
13
    }
14

15
    @GetMapping(value = "/", produces = "text/html")
16
public String hello() {
17
    return """
18
        <!DOCTYPE html>
19
        <html>
20
        <head>
21
            <title>Spring Boot Demo</title>
22
            <style>
23
                body { font-family: Arial, sans-serif; margin: 40px; }
24
                h1 { color: #4CAF50; }
25
                .info { background-color: #f0f0f0; padding: 20px; border-radius: 5px; }
26
            </style>
27
        </head>
28
        <body>
29
            <h1>Hello from Jenkins CI/CD with JDK 21!</h1>
30
            <p>新绛之海</p>
31
            <div class="info">
32
                <h2>系统信息：</h2>
33
                <ul>
34
                    <li>JDK版本：22</li>
35
                    <li>应用框架：Spring Boot</li>
36
                    <li>CI/CD：Jenkins</li>
37
                    <li>当前时间：%s</li>
38
                </ul>
39
            </div>
40
        </body>
41
        </html>
42
        """.formatted(java.time.LocalDateTime.now());
43
}
44
}

2.1.1.2 Dockerfile#

1
# 使用 JDK 21 的运行时镜像
2
FROM eclipse-temurin:21-jre-alpine
3
WORKDIR /app
4
# 复制 maven 打包好的 jar
5
COPY target/demo-1.0.jar app.jar
6
ENTRYPOINT ["java", "-jar", "app.jar"]

2.1.1.3 pom.xml#

1
<?xml version="1.0" encoding="UTF-8"?>
2
<project xmlns="http://maven.apache.org/POM/4.0.0">
3
    <modelVersion>4.0.0</modelVersion>
4
    <groupId>com.example</groupId>
5
    <artifactId>demo</artifactId>
6
    <version>1.0</version>
7
    <packaging>jar</packaging>
8

9
    <parent>
10
        <groupId>org.springframework.boot</groupId>
11
        <artifactId>spring-boot-starter-parent</artifactId>
12
        <version>3.2.0</version>
13
    </parent>
14

15
    <properties>
16
        <java.version>21</java.version> <!-- 明确指定 21 -->
17
    </properties>
18

19
    <dependencies>
20
        <dependency>
21
            <groupId>org.springframework.boot</groupId>
22
            <artifactId>spring-boot-starter-web</artifactId>
23
        </dependency>
24
        <dependency>
25
            <groupId>org.springframework.boot</groupId>
26
            <artifactId>spring-boot-starter-test</artifactId>
27
            <scope>test</scope>
28
        </dependency>
29
    </dependencies>
30

31
    <build>
32
        <plugins>
33
            <plugin>
34
                <groupId>org.springframework.boot</groupId>
35
                <artifactId>spring-boot-maven-plugin</artifactId>
36
            </plugin>
37
        </plugins>
38
    </build>
39
</project>

2.1.2 创建流水线文件#

创建文件夹.github/workflows,然后在文件夹中创建使用 .yml 或 .yaml 作为文件扩展名的流水线文件，github即可自动扫描该文件触发流水线

这里创建为github-actions-demo.yml

1
name: 构建并上传到 Docker Hub
2
run-name: ${{ github.actor }} 正在打包上传镜像
3

4
on:
5
  push:
6
    branches: [ main ]
7

8
jobs:
9
  build:
10
    runs-on: ubuntu-latest
11
    steps:
12
      - name: 检出代码
13
        uses: actions/checkout@v6
14

15
      - name: 设置 JDK 21
16
        uses: actions/setup-java@v4
17
        with:
18
          java-version: '21'
19
          distribution: 'temurin'
20
          cache: maven
21

22
      - name: Maven 打包项目
23
        run: mvn clean package -DskipTests
24

25
      - name: 登录 Docker Hub
26
        uses: docker/login-action@v3
27
        with:
28
          username: ${{ secrets.DOCKER_HUB_USERNAME }}
29
          password: ${{ secrets.DOCKER_HUB_TOKEN }}
30

31
      - name: 构建并推送 Docker 镜像
32
        uses: docker/build-push-action@v6
33
        with:
34
          context: .
35
          push: true
36
          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/java_test:latest

提交后即可自动触发流水线，但还缺少一些变量，因此会构建失败

2.1.3 添加秘钥#

路径：项目 → Settings → Secrets and variables → Actions → New repository secret

添加以下两个秘钥

1
DOCKER_HUB_USERNAME
2
DOCKER_HUB_TOKEN

秘钥的值在docker hub中创建

创建成功后将生成的token填入github的DOCKER_HUB_TOKEN，DOCKER_HUB_USERNAME填入用户名

2.1.4 流水线构建#

提交代码，再次触发构建

提交后回到action界面

可以看到构建成功

2.1.5 使用docker拉取构建镜像#

查看构建的镜像

1
docker pull laixianshen/java_test:latest
2

3
docker run -d -p 8899:8080 laixianshen/java_test:latest

3.1 action项目示例二#

实现效果：当在 GitHub 上创建一个「发布版本（Release）」时，自动用 maven 打包 Java 项目，并把构建好的 jar 包发布到 GitHub Packages 仓库。

3.1.1 创建修改文件#

还是使用java_test项目，再创建一个新的流水线文件publish.yml，并填入如下内容

1
name: Maven 发布到 GitHub Packages
2
run-name: ${{ github.actor }} 正在发布 Maven 包到 GitHub Packages
3

4
on:
5
  release:
6
    types: [created]
7

8
jobs:
9
  publish:
10
    runs-on: ubuntu-latest
11
    permissions:
12
      contents: read
13
      packages: write
14

15
    steps:
16
      - name: 检出代码
17
        uses: actions/checkout@v4
18

19
      - name: 设置 JDK 21
20
        uses: actions/setup-java@v4
21
        with:
22
          java-version: '21'
23
          distribution: 'temurin'
24

25
      - name: 创建 Maven settings.xml 认证文件
26
        run: |
27
          cat > ~/.m2/settings.xml << EOF
28
          <settings>
29
            <servers>
30
              <server>
31
                <id>github</id>
32
                <username>${{ github.actor }}</username>
33
                <password>${{ secrets.GITHUB_TOKEN }}</password>
34
              </server>
35
            </servers>
36
          </settings>
37
          EOF
38

39
      - name: Maven 打包项目
40
        run: mvn clean package -DskipTests
41

42
      - name: 发布到 GitHub Packages
43
        run: mvn deploy

修改pom.xml文件，加上 GitHub Packages 的配置 这个仓库不用创建，触发流水线时会自动创建

1
<distributionManagement>
2
  <repository>
3
    <id>github</id>
4
    <url>https://maven.pkg.github.com/你的用户名/你的仓库名</url>
5
  </repository>
6
</distributionManagement>

整体文件内容：

1
<?xml version="1.0" encoding="UTF-8"?>
2
<project xmlns="http://maven.apache.org/POM/4.0.0">
3
    <modelVersion>4.0.0</modelVersion>
4
    <groupId>com.example</groupId>
5
    <artifactId>demo</artifactId>
6
    <version>1.0</version>
7
    <packaging>jar</packaging>
8

9
    <parent>
10
        <groupId>org.springframework.boot</groupId>
11
        <artifactId>spring-boot-starter-parent</artifactId>
12
        <version>3.2.0</version>
13
    </parent>
14

15
    <properties>
16
        <java.version>21</java.version>
17
    </properties>
18

19
    <dependencies>
20
        <dependency>
21
            <groupId>org.springframework.boot</groupId>
22
            <artifactId>spring-boot-starter-web</artifactId>
23
        </dependency>
24
    </dependencies>
25

26
    <!-- 关键：配置 GitHub Packages 仓库地址 -->
27
    <distributionManagement>
28
        <repository>
29
            <id>github</id>
30
            <url>https://maven.pkg.github.com/laixianshenboss/java_test</url>
31
        </repository>
32
    </distributionManagement>
33

34
    <build>
35
        <plugins>
36
            <plugin>
37
                <groupId>org.springframework.boot</groupId>
38
                <artifactId>spring-boot-maven-plugin</artifactId>
39
            </plugin>
40
        </plugins>
41
    </build>
42
</project>

3.1.2 触发构建#

再此创建版本，触发构建

选择标签，填写版本标题后提交

最后回到action界面，查看构建结果

**注意：**如果构建失败，修改文件后再次创建版本构建时，需要选择新的tag，否则构建时使用的文件还是旧版本的

3.1.3 查看构建产物#

回到账号首页，选择packages

或者项目的packages

可以看到构建的jar包，点击即可下载使用

3.1.4 下载产物部署#

将生成的产物下载后，上传到安装了java环境的机器中运行

1
# 后台运行在4433端口，并将日志写入文件
2
nohup java -jar demo-1.0.jar --server.port=4433 > app.log 2>&1 &

4.1 自建runner#

使用自建的runner运行器的配置方式与其余cicd工具配置相似

前往：项目设置->actons->runner->new self-hosted runner，进入后选择好对应的系统

之后根据提供的配置进行安装配置

音乐

音乐

一、github actions 使用#

1.1 基础功能使用#

1.1.1 流水线管理#

1.1.2 流水线手动触发#

2.1 action项目示例#

2.1.1 github创建项目#

2.1.1.1 java源码#

2.1.1.2 Dockerfile#

2.1.1.3 pom.xml#

2.1.2 创建流水线文件#

2.1.3 添加秘钥#

2.1.4 流水线构建#

2.1.5 使用docker拉取构建镜像#

3.1 action项目示例二#

3.1.1 创建修改文件#

3.1.2 触发构建#

3.1.3 查看构建产物#

3.1.4 下载产物部署#

4.1 自建runner#

文章分享

音乐

文章目录

音乐

音乐

github action使用

一、github actions 使用#

1.1 基础功能使用#

1.1.1 流水线管理#

1.1.2 流水线手动触发#

2.1 action项目示例#

2.1.1 github创建项目#

2.1.1.1 java源码#

2.1.1.2 Dockerfile#

2.1.1.3 pom.xml#

2.1.2 创建流水线文件#

2.1.3 添加秘钥#

2.1.4 流水线构建#

2.1.5 使用docker拉取构建镜像#

3.1 action项目示例二#

3.1.1 创建修改文件#

3.1.2 触发构建#

3.1.3 查看构建产物#

3.1.4 下载产物部署#

4.1 自建runner#

文章分享

音乐

文章目录