|
1 | 1 | # GitHub Actions Workflows
|
2 | 2 |
|
3 |
| -本项目包含以下 GitHub Actions workflows: |
| 3 | +本项目包含以下 GitHub Actions workflow: |
| 4 | + |
| 5 | +## build-jar.yml - JAR 构建工作流 |
| 6 | + |
| 7 | +**触发条件:** |
| 8 | +- 每次代码提交到任何分支 |
| 9 | +- Pull Request 到 main/master 分支 |
4 | 10 |
|
5 |
| -## 1. build-jar.yml - JAR 构建工作流 |
6 |
| -**触发条件:** 每次代码提交到任何分支 |
7 | 11 | **功能:**
|
8 | 12 | - 使用 JDK 8 和 Gradle 5.6.4
|
9 | 13 | - 构建标准 JAR 文件
|
|
15 | 19 | - `jar-files-{run_number}`: 包含所有 JAR 文件
|
16 | 20 | - `plugin-zip-{run_number}`: 包含插件分发 ZIP 文件
|
17 | 21 |
|
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 |
| - |
32 | 22 | ## 使用说明
|
33 | 23 |
|
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`) |
37 | 30 |
|
38 | 31 | ## 下载构建产物
|
39 | 32 |
|
40 |
| -1. 进入 GitHub 项目的 Actions 页面 |
| 33 | +1. 进入 GitHub 项目的 **Actions** 页面 |
41 | 34 | 2. 选择对应的 workflow run
|
42 |
| -3. 在页面底部的 Artifacts 部分下载需要的文件 |
| 35 | +3. 在页面底部的 **Artifacts** 部分下载需要的文件 |
43 | 36 |
|
44 | 37 | ## 构建产物说明
|
45 | 38 |
|
46 | 39 | - **标准 JAR**: `easy_javadoc-{version}.jar`
|
47 | 40 | - **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 页面查看详细的构建日志 |
0 commit comments