Skip to content

Commit 9bf380a

Browse files
committed
chore(workflows): update build-jar workflow and README
- Upgrade Gradle version to 5.6.4 and update the Gradle action to v2.12.0 - Change upload-artifact action to v4 for improved functionality - Enhance README.md with clearer workflow descriptions and troubleshooting tips
1 parent df40cf0 commit 9bf380a

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

.github/workflows/README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# GitHub Actions Workflows
22

3-
本项目包含以下 GitHub Actions workflows:
3+
本项目包含以下 GitHub Actions workflow:
4+
5+
## build-jar.yml - JAR 构建工作流
6+
7+
**触发条件:**
8+
- 每次代码提交到任何分支
9+
- Pull Request 到 main/master 分支
410

5-
## 1. build-jar.yml - JAR 构建工作流
6-
**触发条件:** 每次代码提交到任何分支
711
**功能:**
812
- 使用 JDK 8 和 Gradle 5.6.4
913
- 构建标准 JAR 文件
@@ -15,34 +19,30 @@
1519
- `jar-files-{run_number}`: 包含所有 JAR 文件
1620
- `plugin-zip-{run_number}`: 包含插件分发 ZIP 文件
1721

18-
## 2. ci.yml - 持续集成工作流
19-
**触发条件:** 代码提交和 Pull Request
20-
**功能:**
21-
- 运行测试
22-
- 构建项目
23-
- 上传测试结果和构建产物
24-
25-
## 3. build.yml - 完整构建和发布工作流
26-
**触发条件:** 主分支提交
27-
**功能:**
28-
- 完整构建流程
29-
- 自动创建 GitHub Release
30-
- 上传 JAR 文件到 Release
31-
3222
## 使用说明
3323

34-
1. **每次提交**都会触发 `build-jar.yml`,自动构建 JAR 文件
35-
2. 构建完成后,可以在 Actions 页面下载对应的 artifacts
36-
3. 主分支的提交会额外触发完整的发布流程
24+
1. **每次提交**都会触发自动构建,生成 JAR 文件
25+
2. 构建完成后,可以在 GitHub Actions 页面下载对应的 artifacts
26+
3. 构建过程包括:
27+
- 标准 JAR 构建 (`gradle jar`)
28+
- Fat JAR 构建 (`gradle fatJar`)
29+
- IntelliJ 插件构建 (`gradle buildPlugin`)
3730

3831
## 下载构建产物
3932

40-
1. 进入 GitHub 项目的 Actions 页面
33+
1. 进入 GitHub 项目的 **Actions** 页面
4134
2. 选择对应的 workflow run
42-
3. 在页面底部的 Artifacts 部分下载需要的文件
35+
3. 在页面底部的 **Artifacts** 部分下载需要的文件
4336

4437
## 构建产物说明
4538

4639
- **标准 JAR**: `easy_javadoc-{version}.jar`
4740
- **Fat JAR**: `easy_javadoc-{version}-all.jar` (包含所有依赖)
48-
- **插件 ZIP**: `Easy Javadoc-{version}.zip` (IntelliJ 插件分发包)
41+
- **插件 ZIP**: `Easy Javadoc-{version}.zip` (IntelliJ 插件分发包)
42+
43+
## 故障排除
44+
45+
如果构建失败,请检查:
46+
1. build.gradle 文件语法是否正确
47+
2. 依赖版本是否兼容
48+
3. 在 Actions 页面查看详细的构建日志

.github/workflows/build-jar.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ jobs:
2020
java-version: '8'
2121
distribution: 'temurin'
2222

23-
- name: Setup Gradle 5.x
24-
uses: gradle/gradle-build-action@v2
23+
- name: Setup Gradle
24+
uses: gradle/gradle-build-action@v2.12.0
2525
with:
2626
gradle-version: '5.6.4'
2727

@@ -43,14 +43,14 @@ jobs:
4343
find build/distributions -name "*.zip" -type f | head -5
4444
4545
- name: Upload JAR files
46-
uses: actions/upload-artifact@v3
46+
uses: actions/upload-artifact@v4
4747
with:
4848
name: jar-files-${{ github.run_number }}
4949
path: build/libs/*.jar
5050
retention-days: 30
5151

5252
- name: Upload Plugin ZIP
53-
uses: actions/upload-artifact@v3
53+
uses: actions/upload-artifact@v4
5454
with:
5555
name: plugin-zip-${{ github.run_number }}
5656
path: build/distributions/*.zip

0 commit comments

Comments
 (0)