📖GitHub Actions使用文档

新增:📖GitHub Actions使用文档
欢迎提出意见
This commit is contained in:
essesoul
2022-12-05 23:50:02 +08:00
parent 080ca334b6
commit 3a5cff6d24
12 changed files with 77 additions and 0 deletions

77
docs/README.md Normal file
View File

@@ -0,0 +1,77 @@
# Github actions 编译配置教程
## 1.Fork本项目
[Fork本项目](https://github.com/tw93/Pake/fork)
## 2.前往actions页面启用GitHub actions
![image-20221205230324046](assets/image-20221205230324046.png)
![image-20221205230432205](assets/image-20221205230432205.png)
## 3.修改app.csv文件
修改app.csv文件自行将第二行以后的内容替换成自定义内容
![image-20221205230553980](assets/image-20221205230553980.png)
格式为:`Linux下应用名称,Mac和Windows下应用名称,中文名称,网址`,注意使用英文逗号分隔
## 4.上传图标
- 上传.icns文件至`/src-tauri/icons`目录下(必须)
- 上传.ico和.png文件至`/src-tauri/png`目录下(如果使用脚本自动转换可以跳过此步)
**注意:需要两个.ico文件和一个.png文件参考下表**
| 文件名称 | 说明 |
| ----------- | ---------------- |
| app_32.ico | 32*32的ico图标 |
| app_256.ico | 256*256的ico图标 |
| app_512.png | 512*512的png图片 |
> 你也可以直接git整个项目到本地使用项目根目录下的icns2png.py文件批量将.icns文件转换成.ico和.png文件.icns文件是必须的
>
> 转换完成后别忘了将对应文件上传
## 5.更改配置文件
前往`/src-tauri/`目录,修改**tauri.conf.json**文件
参考下面图片自定义配置,其中**带星号的内容是必须修改**的,其他可以使用默认
![image-20221205233244356](assets/image-20221205233244356.png)
## 6.发布以开始运行自动编译
- 点击前往release页面
![image-20221205233624044](assets/image-20221205233624044.png)
![image-20221205233722029](assets/image-20221205233722029.png)
- 点击**Create a new release**
![image-20221205233806355](assets/image-20221205233806355.png)
- 点击**Choose a tag**,输入`V0.1.0`(版本号可自定义,但是**必须以大写V开头**
![image-20221205233956978](assets/image-20221205233956978.png)
- 点击下方的**Creat new tag**按钮
![image-20221205234436283](assets/image-20221205234436283.png)
- 填写标题和内容(可选)
- 如果不是在master分支修改需要在target下拉栏选择对应分支
- 点击**Publish release**
- 此时前往actions页面确保出现新workflow
![image-20221205234306770](assets/image-20221205234306770.png)
在编译完成后即可在release页面看到编译完成后生成的文件编译大约需要10-30分钟