docs: 测试新的构建

This commit is contained in:
ZacharyZcR 2025-07-17 17:53:18 +08:00
parent b1e67fd7b1
commit 487681b353
2 changed files with 201 additions and 235 deletions

View File

@ -1,148 +1,126 @@
name: 发布构建
# 项目名称
project_name: "{{ .Env.PROJECT_NAME }}"
on:
push:
tags:
- 'v*'
branches:
- dev # 添加 dev 分支支持
pull_request:
branches:
- main
- master
workflow_dispatch:
inputs:
tag:
description: '发布标签'
required: false
default: 'v1.0.0'
test_mode:
description: '测试模式 (不会发布)'
type: boolean
default: false
# 构建前钩子
before:
hooks:
- go mod tidy
- go mod download
- go generate ./...
permissions:
contents: write
issues: write
pull-requests: write
# 构建配置
builds:
- id: default
binary: "{{ .ProjectName }}"
env:
- CGO_ENABLED=0
goos:
- windows
- linux
- darwin
goarch:
- amd64
- arm64
- "386"
goarm:
- "7"
ignore:
- goos: darwin
goarch: "386"
- goos: windows
goarch: arm64
flags:
- -trimpath
ldflags:
- -s -w
- -X main.version={{ .Version }}
- -X main.commit={{ .ShortCommit }}
- -X main.date={{ .Date }}
- -X main.builtBy=goreleaser
mod_timestamp: "{{ .CommitTimestamp }}"
jobs:
goreleaser:
name: 构建和发布
runs-on: ubuntu-latest
timeout-minutes: 60
# UPX 压缩
upx:
- ids: [default]
enabled: true
goos: ["windows", "linux"]
goarch: ["amd64", "386"]
compress: best
brute: false
lzma: false
steps:
- name: 📥 检出代码
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITHUB_TOKEN }}
# 归档配置
archives:
- id: default
format: binary
allow_different_binary_count: true
name_template: >-
{{ .ProjectName }}_{{ .Version }}_
{{- if eq .Os "darwin" }}mac
{{- else }}{{ .Os }}{{ end }}_
{{- if eq .Arch "amd64" }}x64
{{- else if eq .Arch "386" }}x32
{{- else }}{{ .Arch }}{{ end }}
{{- if .Arm }}v{{ .Arm }}{{ end }}
{{- if eq .Os "windows" }}.exe{{ end }}
- name: 🔍 判断运行模式
id: mode
run: |
if [[ "${{ github.event_name }}" == "push" && "${{ github.ref }}" == refs/tags/* ]]; then
echo "mode=release" >> $GITHUB_OUTPUT
echo "version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
elif [[ "${{ github.event.inputs.test_mode }}" == "true" ]]; then
echo "mode=test" >> $GITHUB_OUTPUT
echo "version=${{ github.event.inputs.tag }}" >> $GITHUB_OUTPUT
else
echo "mode=snapshot" >> $GITHUB_OUTPUT
echo "version=dev-${GITHUB_SHA:0:7}" >> $GITHUB_OUTPUT
fi
# 校验和
checksum:
name_template: 'checksums.txt'
algorithm: sha256
echo "owner=${GITHUB_REPOSITORY_OWNER}" >> $GITHUB_OUTPUT
echo "repo=${GITHUB_REPOSITORY#*/}" >> $GITHUB_OUTPUT
# 变更日志
changelog:
sort: asc
use: github
filters:
exclude:
- "^docs:"
- "^test:"
- "^ci:"
- "^chore:"
- "Merge pull request"
- "Merge branch"
groups:
- title: "🚀 新功能"
regexp: "^.*feat[(\\w)]*:+.*$"
order: 0
- title: "🐛 问题修复"
regexp: "^.*fix[(\\w)]*:+.*$"
order: 1
- title: "📚 文档更新"
regexp: "^.*docs[(\\w)]*:+.*$"
order: 2
- title: "🔧 其他改进"
order: 999
- name: 🐹 设置 Go 环境
uses: actions/setup-go@v5
with:
go-version: '1.21'
cache: true
# 发布配置
release:
github:
owner: "{{ .Env.GITHUB_OWNER }}"
name: "{{ .Env.GITHUB_REPO }}"
draft: false
prerelease: auto
mode: replace
header: |
## 🎉 {{ .ProjectName }} {{ .Tag }} 发布说明
- name: 📦 下载依赖
run: |
go mod download
go mod verify
感谢使用 {{ .ProjectName }}!本次发布包含以下改进:
footer: |
## 📥 安装说明
- name: 🗜️ 安装 UPX 压缩工具
uses: crazy-max/ghaction-upx@v3
with:
install-only: true
下载对应平台的二进制文件即可使用。
- name: 显示构建环境信息
run: |
echo "Go 版本: $(go version)"
echo "UPX 版本: $(upx --version)"
echo "运行模式: ${{ steps.mode.outputs.mode }}"
echo "版本: ${{ steps.mode.outputs.version }}"
echo "仓库: ${{ steps.mode.outputs.owner }}/${{ steps.mode.outputs.repo }}"
**完整更新日志**: https://github.com/{{ .Env.GITHUB_OWNER }}/{{ .Env.GITHUB_REPO }}/compare/{{ .PreviousTag }}...{{ .Tag }}
- name: 🧪 运行测试
run: |
go test -v ./...
---
- name: 🔍 验证 GoReleaser 配置
uses: goreleaser/goreleaser-action@v5
with:
distribution: goreleaser
version: latest
args: check -f .github/conf/.goreleaser.yml
如有问题请提交 [Issue](https://github.com/{{ .Env.GITHUB_OWNER }}/{{ .Env.GITHUB_REPO }}/issues) 💬
- name: 🚀 正式发布
if: steps.mode.outputs.mode == 'release'
uses: goreleaser/goreleaser-action@v5
with:
distribution: goreleaser
version: latest
args: release --clean -f .github/conf/.goreleaser.yml
workdir: .
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_OWNER: ${{ steps.mode.outputs.owner }}
GITHUB_REPO: ${{ steps.mode.outputs.repo }}
PROJECT_NAME: ${{ steps.mode.outputs.repo }}
# 快照版本
snapshot:
name_template: "{{ incpatch .Version }}-dev-{{ .ShortCommit }}"
- name: 🧪 测试构建 (Snapshot 模式)
if: steps.mode.outputs.mode != 'release'
uses: goreleaser/goreleaser-action@v5
with:
distribution: goreleaser
version: latest
args: release --snapshot --clean -f .github/conf/.goreleaser.yml
workdir: .
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_OWNER: ${{ steps.mode.outputs.owner }}
GITHUB_REPO: ${{ steps.mode.outputs.repo }}
PROJECT_NAME: ${{ steps.mode.outputs.repo }}
- name: 📋 上传构建产物
uses: actions/upload-artifact@v4
with:
name: |
${{ steps.mode.outputs.mode == 'release' && '正式发布' || '测试构建' }}-${{ steps.mode.outputs.version }}
path: |
dist/
retention-days: ${{ steps.mode.outputs.mode == 'release' && 90 || 7 }}
- name: 📊 生成构建报告
if: always()
run: |
mode_emoji="${{ steps.mode.outputs.mode == 'release' && '🎉' || '🧪' }}"
echo "## ${mode_emoji} 构建完成报告" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "- **模式**: ${{ steps.mode.outputs.mode }}" >> $GITHUB_STEP_SUMMARY
echo "- **版本**: ${{ steps.mode.outputs.version }}" >> $GITHUB_STEP_SUMMARY
echo "- **仓库**: ${{ steps.mode.outputs.owner }}/${{ steps.mode.outputs.repo }}" >> $GITHUB_STEP_SUMMARY
echo "- **构建时间**: $(date)" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
if [ -d "dist" ]; then
echo "### 📦 生成的文件:" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
ls -la dist/ >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
fi
# 元数据
metadata:
mod_timestamp: "{{ .CommitTimestamp }}"

View File

@ -1,56 +1,46 @@
name: 测试构建
name: 发布构建
on:
push:
branches:
- dev
- develop
- feature/*
pull_request:
branches:
- main
- master
- dev
workflow_dispatch:
tags:
- 'v*' # 只响应以 v 开头的标签,如 v1.0.0
workflow_dispatch: # 支持手动触发
inputs:
branch:
description: '测试分支'
required: false
default: 'dev'
skip_tests:
description: '跳过测试'
type: boolean
default: false
tag:
description: '发布标签'
required: true
default: 'v1.0.0'
permissions:
contents: read
contents: write
issues: write
pull-requests: write
jobs:
test-build:
name: 测试构建
goreleaser:
name: 构建和发布
runs-on: ubuntu-latest
timeout-minutes: 30
timeout-minutes: 60
steps:
- name: 📥 检出代码
uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{ github.event.inputs.branch || github.ref }}
fetch-depth: 0 # 获取完整的 git 历史,用于生成变更日志
token: ${{ secrets.GITHUB_TOKEN }}
- name: 🔍 获取项目信息
id: project
run: |
echo "owner=${GITHUB_REPOSITORY_OWNER}" >> $GITHUB_OUTPUT
echo "repo=${GITHUB_REPOSITORY#*/}" >> $GITHUB_OUTPUT
echo "branch=${GITHUB_REF#refs/heads/}" >> $GITHUB_OUTPUT
echo "short_sha=${GITHUB_SHA:0:7}" >> $GITHUB_OUTPUT
echo "version=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
- name: 🐹 设置 Go 环境
uses: actions/setup-go@v5
with:
go-version: '1.21'
cache: true
go-version: '1.21' # 使用更新的 Go 版本
cache: true # 启用 Go 模块缓存
- name: 📦 下载依赖
run: |
@ -66,12 +56,10 @@ jobs:
run: |
echo "Go 版本: $(go version)"
echo "UPX 版本: $(upx --version)"
echo "分支: ${{ steps.project.outputs.branch }}"
echo "提交: ${{ steps.project.outputs.short_sha }}"
echo "Git 标签: ${{ steps.project.outputs.version }}"
echo "仓库: ${{ steps.project.outputs.owner }}/${{ steps.project.outputs.repo }}"
- name: 🧪 运行测试
if: ${{ !inputs.skip_tests }}
run: |
go test -v ./...
@ -82,12 +70,12 @@ jobs:
version: latest
args: check -f .github/conf/.goreleaser.yml
- name: 🚀 测试构建 (Snapshot 模式)
- name: 🚀 构建和发布
uses: goreleaser/goreleaser-action@v5
with:
distribution: goreleaser
version: latest
args: release --snapshot --clean -f .github/conf/.goreleaser.yml
args: release --clean -f .github/conf/.goreleaser.yml
workdir: .
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@ -95,89 +83,89 @@ jobs:
GITHUB_REPO: ${{ steps.project.outputs.repo }}
PROJECT_NAME: ${{ steps.project.outputs.repo }}
- name: 📋 上传测试产物
- name: 📋 上传构建产物
uses: actions/upload-artifact@v4
if: always()
with:
name: 测试构建-${{ steps.project.outputs.branch }}-${{ steps.project.outputs.short_sha }}
name: 构建产物-${{ steps.project.outputs.version }}
path: |
dist/
retention-days: 7
!dist/*.txt
retention-days: 30
- name: 🧪 测试生成的二进制文件
run: |
echo "## 🧪 测试二进制文件" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
for binary in dist/*linux*amd64*; do
if [[ -f "$binary" && -x "$binary" ]]; then
echo "测试文件: $binary"
file_info=$(file "$binary")
echo "- **文件信息**: $file_info" >> $GITHUB_STEP_SUMMARY
# 测试运行
if timeout 10s "$binary" --help > /dev/null 2>&1; then
echo "- **运行测试**: ✅ 通过" >> $GITHUB_STEP_SUMMARY
else
echo "- **运行测试**: ❌ 失败" >> $GITHUB_STEP_SUMMARY
fi
break
fi
done
- name: 📊 生成测试报告
- name: 📊 生成构建报告
if: always()
run: |
echo "## 🎯 测试构建报告" >> $GITHUB_STEP_SUMMARY
echo "## 🎉 构建完成报告" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "- **分支**: ${{ steps.project.outputs.branch }}" >> $GITHUB_STEP_SUMMARY
echo "- **提交**: ${{ steps.project.outputs.short_sha }}" >> $GITHUB_STEP_SUMMARY
echo "- **版本**: ${{ steps.project.outputs.version }}" >> $GITHUB_STEP_SUMMARY
echo "- **仓库**: ${{ steps.project.outputs.owner }}/${{ steps.project.outputs.repo }}" >> $GITHUB_STEP_SUMMARY
echo "- **Go 版本**: $(go version | cut -d' ' -f3)" >> $GITHUB_STEP_SUMMARY
echo "- **构建时间**: $(date)" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
if [ -d "dist" ]; then
echo "### 📦 生成的文件:" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
ls -la dist/ | head -20 >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
echo "### 📏 文件大小统计:" >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
du -h dist/* | sort -h | tail -10 >> $GITHUB_STEP_SUMMARY
ls -la dist/ >> $GITHUB_STEP_SUMMARY
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
fi
# 可选:代码质量检查
quality:
name: 代码质量检查
# 可选:发布到 Docker Hub
docker:
name: 构建 Docker 镜像
runs-on: ubuntu-latest
needs: goreleaser
if: success()
steps:
- name: 📥 检出代码
uses: actions/checkout@v4
- name: 🐹 设置 Go 环境
uses: actions/setup-go@v5
- name: 🔍 获取元数据
id: meta
uses: docker/metadata-action@v5
with:
go-version: '1.21'
cache: true
images: |
${{ github.repository }}
tags: |
type=ref,event=tag
type=raw,value=latest,enable={{is_default_branch}}
- name: 🔍 代码格式检查
- name: 🐳 设置 Docker Buildx
uses: docker/setup-buildx-action@v3
- name: 🔐 登录 Docker Hub
uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
- name: 🚀 构建并推送 Docker 镜像
uses: docker/build-push-action@v5
with:
context: .
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
# 可选:通知步骤
notify:
name: 发送通知
runs-on: ubuntu-latest
needs: [goreleaser]
if: always()
steps:
- name: 📧 发送成功通知
if: needs.goreleaser.result == 'success'
run: |
if [ "$(gofmt -l . | wc -l)" -gt 0 ]; then
echo "❌ 代码格式不符合标准"
gofmt -l .
exit 1
fi
echo "✅ 代码格式检查通过"
echo "✅ 发布成功完成!"
echo "版本: ${GITHUB_REF#refs/tags/}"
echo "查看发布: https://github.com/${{ github.repository }}/releases"
- name: 🧹 代码静态分析
uses: golangci/golangci-lint-action@v3
with:
version: latest
args: --timeout=5m
- name: 🔒 安全检查
uses: securecodewarrior/github-action-add-sarif@v1
with:
sarif-file: 'gosec.sarif'
continue-on-error: true
- name: ⚠️ 发送失败通知
if: needs.goreleaser.result == 'failure'
run: |
echo "❌ 发布失败!"
echo "请检查构建日志: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"