mirror of
https://github.com/wwiinnddyy/LanMountainDesktop.git
synced 2026-06-22 17:24:27 +08:00
feat.新增了插件开发文档
This commit is contained in:
lincube
215
docs/Plugins develop/06-CI-CD与自动化/01-GitHub Actions入门.md
Normal file
215
docs/Plugins develop/06-CI-CD与自动化/01-GitHub Actions入门.md
Normal file
@@ -0,0 +1,215 @@
|
||||
# 01-GitHub Actions入门
|
||||
|
||||
GitHub Actions 是自动化构建、测试和发布插件的强大工具。本文介绍如何为插件项目配置 CI/CD 流程。
|
||||
|
||||
---
|
||||
|
||||
## 🎯 什么是 GitHub Actions
|
||||
|
||||
GitHub Actions 是 GitHub 提供的持续集成/持续部署（CI/CD）服务，可以：
|
||||
|
||||
- ✅ 自动构建插件
|
||||
- ✅ 运行单元测试
|
||||
- ✅ 打包 .laapp 文件
|
||||
- ✅ 自动发布到 GitHub Releases
|
||||
|
||||
---
|
||||
|
||||
## 📁 工作流文件位置
|
||||
|
||||
```
|
||||
.github/workflows/
|
||||
├── build.yml # 构建工作流
|
||||
├── release.yml # 发布工作流
|
||||
└── code-quality.yml # 代码质量检查
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 基础工作流示例
|
||||
|
||||
### 最简单的构建工作流
|
||||
|
||||
```yaml
|
||||
# .github/workflows/build.yml
|
||||
name: Build Plugin
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main, master]
|
||||
pull_request:
|
||||
branches: [main, master]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: windows-latest
|
||||
|
||||
steps:
|
||||
# 1. 检出代码
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# 2. 设置 .NET
|
||||
- name: Setup .NET
|
||||
uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: '10.0.x'
|
||||
|
||||
# 3. 还原依赖
|
||||
- name: Restore
|
||||
run: dotnet restore
|
||||
|
||||
# 4. 构建
|
||||
- name: Build
|
||||
run: dotnet build --configuration Release --no-restore
|
||||
|
||||
# 5. 上传构建产物
|
||||
- name: Upload Artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: plugin-package
|
||||
path: bin/Release/net10.0/*.laapp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 工作流详解
|
||||
|
||||
### 触发条件（on）
|
||||
|
||||
```yaml
|
||||
on:
|
||||
# 推送到指定分支时触发
|
||||
push:
|
||||
branches: [main, master, develop]
|
||||
|
||||
# 创建 Pull Request 时触发
|
||||
pull_request:
|
||||
branches: [main, master]
|
||||
|
||||
# 手动触发
|
||||
workflow_dispatch:
|
||||
|
||||
# 定时触发（每天凌晨2点）
|
||||
schedule:
|
||||
- cron: '0 2 * * *'
|
||||
|
||||
# 创建标签时触发（用于发布）
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
```
|
||||
|
||||
### 运行环境（runs-on）
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
build:
|
||||
runs-on: windows-latest # Windows 环境
|
||||
# 或
|
||||
runs-on: ubuntu-latest # Linux 环境
|
||||
# 或
|
||||
runs-on: macos-latest # macOS 环境
|
||||
```
|
||||
|
||||
### 矩阵构建（多平台）
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
build:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [windows-latest, ubuntu-latest, macos-latest]
|
||||
dotnet: ['10.0.x']
|
||||
|
||||
runs-on: ${{ matrix.os }}
|
||||
|
||||
steps:
|
||||
- uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: ${{ matrix.dotnet }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 常用 Actions
|
||||
|
||||
### 检出代码
|
||||
|
||||
```yaml
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0 # 获取完整历史（用于生成版本号）
|
||||
```
|
||||
|
||||
### 设置 .NET
|
||||
|
||||
```yaml
|
||||
- uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: '10.0.x'
|
||||
```
|
||||
|
||||
### 上传产物
|
||||
|
||||
```yaml
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: plugin-package
|
||||
path: bin/Release/net10.0/*.laapp
|
||||
retention-days: 30 # 保留30天
|
||||
```
|
||||
|
||||
### 下载产物
|
||||
|
||||
```yaml
|
||||
- uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: plugin-package
|
||||
path: ./artifacts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 最佳实践
|
||||
|
||||
### 1. 缓存依赖
|
||||
|
||||
```yaml
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.nuget/packages
|
||||
key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-nuget-
|
||||
```
|
||||
|
||||
### 2. 使用语义化版本
|
||||
|
||||
```yaml
|
||||
- name: Get Version
|
||||
id: version
|
||||
run: |
|
||||
VERSION=$(echo ${GITHUB_REF#refs/tags/} | sed 's/^v//')
|
||||
echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
|
||||
```
|
||||
|
||||
### 3. 条件执行
|
||||
|
||||
```yaml
|
||||
- name: Deploy
|
||||
if: github.ref == 'refs/heads/main' # 只在 main 分支执行
|
||||
run: echo "Deploying..."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 下一步
|
||||
|
||||
学习自动打包配置：
|
||||
|
||||
👉 **[02-配置自动构建](02-配置自动构建.md)**
|
||||
|
||||
---
|
||||
|
||||
*最后更新：2026年4月*
|
||||
130
docs/Plugins develop/06-CI-CD与自动化/02-配置自动构建.md
Normal file
130
docs/Plugins develop/06-CI-CD与自动化/02-配置自动构建.md
Normal file
@@ -0,0 +1,130 @@
|
||||
# 02-配置自动构建
|
||||
|
||||
配置 GitHub Actions 自动构建插件项目。
|
||||
|
||||
---
|
||||
|
||||
## 🎯 完整构建工作流
|
||||
|
||||
```yaml
|
||||
# .github/workflows/build.yml
|
||||
name: Build
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main, master]
|
||||
paths-ignore:
|
||||
- '**.md'
|
||||
- '.gitignore'
|
||||
pull_request:
|
||||
branches: [main, master]
|
||||
|
||||
env:
|
||||
DOTNET_VERSION: '10.0.x'
|
||||
CONFIGURATION: 'Release'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: windows-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup .NET
|
||||
uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: ${{ env.DOTNET_VERSION }}
|
||||
|
||||
- name: Cache NuGet
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.nuget/packages
|
||||
key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-nuget-
|
||||
|
||||
- name: Restore
|
||||
run: dotnet restore
|
||||
|
||||
- name: Build
|
||||
run: dotnet build --configuration ${{ env.CONFIGURATION }} --no-restore
|
||||
|
||||
- name: Test
|
||||
run: dotnet test --no-build --verbosity normal
|
||||
|
||||
- name: Upload Artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: plugin-${{ github.run_number }}
|
||||
path: bin/${{ env.CONFIGURATION }}/net10.0/*.laapp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 关键配置说明
|
||||
|
||||
### 路径过滤
|
||||
|
||||
```yaml
|
||||
on:
|
||||
push:
|
||||
paths-ignore:
|
||||
- '**.md' # 忽略文档修改
|
||||
- '.gitignore' # 忽略 gitignore 修改
|
||||
- 'docs/**' # 忽略 docs 文件夹
|
||||
```
|
||||
|
||||
### 环境变量
|
||||
|
||||
```yaml
|
||||
env:
|
||||
DOTNET_VERSION: '10.0.x'
|
||||
CONFIGURATION: 'Release'
|
||||
PLUGIN_NAME: 'MyPlugin'
|
||||
```
|
||||
|
||||
### 构建步骤
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
# 1. 检出
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
# 2. 设置 .NET
|
||||
- uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: ${{ env.DOTNET_VERSION }}
|
||||
|
||||
# 3. 缓存
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
path: ~/.nuget/packages
|
||||
key: nuget-${{ hashFiles('**/*.csproj') }}
|
||||
|
||||
# 4. 还原
|
||||
- run: dotnet restore
|
||||
|
||||
# 5. 构建
|
||||
- run: dotnet build -c ${{ env.CONFIGURATION }} --no-restore
|
||||
|
||||
# 6. 测试
|
||||
- run: dotnet test --no-build
|
||||
|
||||
# 7. 上传
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: plugin
|
||||
path: bin/Release/net10.0/*.laapp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 参考资源
|
||||
|
||||
- [GitHub Actions 文档](https://docs.github.com/actions)
|
||||
- [.NET CI/CD 指南](https://docs.microsoft.com/dotnet/devops/github-actions-overview)
|
||||
|
||||
---
|
||||
|
||||
*最后更新：2026年4月*
|
||||
156
docs/Plugins develop/06-CI-CD与自动化/03-自动打包与发布.md
Normal file
156
docs/Plugins develop/06-CI-CD与自动化/03-自动打包与发布.md
Normal file
@@ -0,0 +1,156 @@
|
||||
# 03-自动打包与发布
|
||||
|
||||
配置 GitHub Actions 自动打包 .laapp 并发布到 GitHub Releases。
|
||||
|
||||
---
|
||||
|
||||
## 🎯 发布工作流
|
||||
|
||||
```yaml
|
||||
# .github/workflows/release.yml
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
|
||||
env:
|
||||
DOTNET_VERSION: '10.0.x'
|
||||
|
||||
jobs:
|
||||
build-and-release:
|
||||
runs-on: windows-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup .NET
|
||||
uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: ${{ env.DOTNET_VERSION }}
|
||||
|
||||
- name: Get Version
|
||||
id: version
|
||||
run: |
|
||||
$version = $env:GITHUB_REF -replace 'refs/tags/v', ''
|
||||
echo "VERSION=$version" >> $env:GITHUB_OUTPUT
|
||||
|
||||
- name: Restore
|
||||
run: dotnet restore
|
||||
|
||||
- name: Build
|
||||
run: dotnet build --configuration Release --no-restore
|
||||
|
||||
- name: Package
|
||||
run: |
|
||||
$version = "${{ steps.version.outputs.VERSION }}"
|
||||
Rename-Item -Path "bin/Release/net10.0/MyPlugin.laapp" -NewName "MyPlugin-$version.laapp"
|
||||
|
||||
- name: Create Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: bin/Release/net10.0/*.laapp
|
||||
generate_release_notes: true
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 发布流程
|
||||
|
||||
### 1. 创建标签
|
||||
|
||||
```bash
|
||||
# 创建版本标签
|
||||
git tag -a v1.0.0 -m "Release version 1.0.0"
|
||||
|
||||
# 推送标签到 GitHub
|
||||
git push origin v1.0.0
|
||||
```
|
||||
|
||||
### 2. 自动触发
|
||||
|
||||
推送标签后，GitHub Actions 会自动：
|
||||
1. 检出代码
|
||||
2. 构建项目
|
||||
3. 打包 .laapp
|
||||
4. 创建 Release
|
||||
5. 上传产物
|
||||
|
||||
### 3. 查看 Release
|
||||
|
||||
在 GitHub 仓库页面 → Releases 查看自动创建的发布。
|
||||
|
||||
---
|
||||
|
||||
## 🔧 高级配置
|
||||
|
||||
### 预发布版本
|
||||
|
||||
```yaml
|
||||
- name: Create Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: bin/Release/net10.0/*.laapp
|
||||
prerelease: ${{ contains(github.ref, 'beta') || contains(github.ref, 'alpha') }}
|
||||
```
|
||||
|
||||
### 生成变更日志
|
||||
|
||||
```yaml
|
||||
- name: Generate Changelog
|
||||
id: changelog
|
||||
uses: mikepenz/release-changelog-builder-action@v4
|
||||
with:
|
||||
configuration: .github/changelog-config.json
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Create Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
body: ${{ steps.changelog.outputs.changelog }}
|
||||
files: bin/Release/net10.0/*.laapp
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 最佳实践
|
||||
|
||||
### 版本号管理
|
||||
|
||||
```yaml
|
||||
- name: Update Version
|
||||
run: |
|
||||
$version = "${{ github.ref_name }}" -replace '^v', ''
|
||||
$json = Get-Content plugin.json | ConvertFrom-Json
|
||||
$json.version = $version
|
||||
$json | ConvertTo-Json | Set-Content plugin.json
|
||||
```
|
||||
|
||||
### 多文件发布
|
||||
|
||||
```yaml
|
||||
- name: Create Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: |
|
||||
bin/Release/net10.0/*.laapp
|
||||
README.md
|
||||
LICENSE
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 下一步
|
||||
|
||||
学习多平台构建：
|
||||
|
||||
👉 **[04-多平台构建策略](04-多平台构建策略.md)**
|
||||
|
||||
---
|
||||
|
||||
*最后更新：2026年4月*
|
||||
Reference in New Issue
Block a user