Skip to content

Commit dcf11ee

Browse files
mmmay0722mmmay0722
committed
feat: add GitHub Actions for Docker image
1 parent 2b7604f commit dcf11ee

File tree

5 files changed

+201
-63
lines changed

5 files changed

+201
-63
lines changed

‎.github/workflows/build-and-push.yml‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
name: Build and Push Docker Images
2+
3+
on:
4+
push:
5+
branches:
6+
- dev
7+
# tags:
8+
# - "v*"
9+
# pull_request:
10+
# branches:
11+
# - main
12+
13+
env:
14+
DOCKERHUB_USERNAME: mmmay0722
15+
DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
16+
REGISTRY: docker.io
17+
18+
jobs:
19+
build-and-push:
20+
runs-on: ubuntu-latest
21+
timeout-minutes: 60
22+
23+
steps:
24+
- name: Checkout code
25+
uses: actions/checkout@v4
26+
27+
- name: Set up Docker Buildx
28+
uses: docker/setup-buildx-action@v3
29+
30+
- name: Log in to Docker Hub
31+
uses: docker/login-action@v3
32+
with:
33+
registry: ${{ env.REGISTRY }}
34+
username: ${{ env.DOCKERHUB_USERNAME }}
35+
password: ${{ env.DOCKERHUB_TOKEN }}
36+
37+
- name: Extract tag name
38+
id: extract_tag
39+
run: |
40+
if [[ $GITHUB_REF == refs/tags/* ]]; then
41+
TAG_NAME=${GITHUB_REF#refs/tags/}
42+
echo "is_tag=true" >> $GITHUB_OUTPUT
43+
else
44+
TAG_NAME="latest"
45+
echo "is_tag=false" >> $GITHUB_OUTPUT
46+
fi
47+
echo "tag_name=$TAG_NAME" >> $GITHUB_OUTPUT
48+
echo "Extracted tag: $TAG_NAME"
49+
50+
- name: Build and push Docker image
51+
uses: docker/build-push-action@v5
52+
timeout-minutes: 30
53+
with:
54+
context: .
55+
file: ./Dockerfile
56+
push: true
57+
tags: ${{ env.REGISTRY }}/${{ env.DOCKERHUB_USERNAME }}/webqa-agent:${{ steps.extract_tag.outputs.tag_name }}
58+
cache-from: type=gha
59+
cache-to: type=gha,mode=max
60+
platforms: linux/amd64
61+
provenance: false
62+
sbom: false
63+
64+
create-release:
65+
needs: build-and-push
66+
runs-on: ubuntu-latest
67+
if: startsWith(github.ref, 'refs/tags/v')
68+
permissions:
69+
contents: write
70+
discussions: write
71+
72+
steps:
73+
- name: Checkout code
74+
uses: actions/checkout@v4
75+
with:
76+
fetch-depth: 0
77+
78+
- name: Extract tag name
79+
id: extract_tag
80+
run: |
81+
TAG_NAME=${GITHUB_REF#refs/tags/}
82+
echo "tag_name=$TAG_NAME" >> $GITHUB_OUTPUT
83+
echo "Current tag: $TAG_NAME"
84+
85+
- name: Generate changelog
86+
id: changelog
87+
run: |
88+
CURRENT_TAG=${{ steps.extract_tag.outputs.tag_name }}
89+
PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD~1 2>/dev/null || echo "")
90+
91+
echo "## 🚀 Release $CURRENT_TAG" > CHANGELOG.md
92+
echo "" >> CHANGELOG.md
93+
echo "### 📦 Docker Images" >> CHANGELOG.md
94+
echo "- \`${{ env.DOCKERHUB_USERNAME }}/webqa-agent:$CURRENT_TAG\`" >> CHANGELOG.md
95+
echo "" >> CHANGELOG.md
96+
97+
if [ -n "$PREVIOUS_TAG" ]; then
98+
echo "### 📝 Changes since $PREVIOUS_TAG" >> CHANGELOG.md
99+
git log --pretty=format:"- %s (%h)" $PREVIOUS_TAG..$CURRENT_TAG >> CHANGELOG.md
100+
else
101+
echo "### 📝 Initial Release" >> CHANGELOG.md
102+
echo "This is the initial release of WebQA Agent." >> CHANGELOG.md
103+
fi
104+
105+
- name: Create GitHub Release
106+
uses: softprops/action-gh-release@v1
107+
with:
108+
tag_name: ${{ steps.extract_tag.outputs.tag_name }}
109+
name: Release ${{ steps.extract_tag.outputs.tag_name }}
110+
body_path: CHANGELOG.md
111+
draft: false
112+
prerelease: false
113+
generate_release_notes: true
114+
env:
115+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
116+
117+
notify:
118+
needs: [build-and-push, create-release]
119+
runs-on: ubuntu-latest
120+
if: always()
121+
122+
steps:
123+
- name: Notify build status
124+
run: |
125+
if [ "${{ needs.build-and-push.result }}" == "success" ]; then
126+
echo "✅ Docker image built and pushed successfully!"
127+
echo "✅ Both versioned and latest tags have been updated!"
128+
else
129+
echo "❌ Docker image build failed!"
130+
exit 1
131+
fi
132+
133+
if [ "${{ needs.create-release.result }}" == "success" ] || [ "${{ needs.create-release.result }}" == "skipped" ]; then
134+
echo "✅ Release process completed successfully!"
135+
else
136+
echo "❌ Release process failed!"
137+
fi

‎README.md‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,19 @@
1919

2020
## 安装与配置
2121

22-
### Docker 快速启动
22+
### 🚀 Docker一键启动（推荐）
2323

2424
在开始之前，请确保已安装 Docker。如未安装，请参考官方安装指南：[Docker 安装指南](https://docs.docker.com/get-started/get-docker/)。
2525

2626
```bash
27-
# 1. 克隆项目
28-
git clone <repository-url>
29-
cd webqa-agent
27+
# 1. 下载配置文件模板
28+
curl -fsSL https://raw.githubusercontent.com/MigoXLab/webqa-agent/main/config/config.yaml.example -o config.yaml
3029

31-
# 2. 配置项目
32-
cp config/config.yaml.example config/config.yaml
33-
# 编辑 config/config.yaml 配置文件
30+
# 2. 编辑配置文件
31+
# 设置 target.url、llm_config.api_key 等参数
3432

35-
# 3. 启动服务（适用于 macOS 与 Linux）
36-
sh start.sh --build # 初次构建镜像，或者重新构建并启动（代码/配置更新后）
37-
sh start.sh --local # 使用已有 webqa-agent 镜像快速启动
33+
# 3. 一键启动
34+
curl -fsSL https://raw.githubusercontent.com/MigoXLab/webqa-agent/main/start.sh | bash
3835
```
3936

4037
### 源码安装

‎docker-compose.yml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@ version: "3.10"
22

33
services:
44
app:
5-
build:
6-
context: .
7-
dockerfile: Dockerfile
8-
image: webqa-agent:latest
5+
image: mmmay0722/webqa-agent:latest
96
container_name: webqa-agent
107
volumes:
118
# 挂载配置文件

‎start.sh‎

Lines changed: 54 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,98 @@
11
#!/bin/bash
22

33
# WebQA Agent Docker 启动脚本
4+
# 支持本地和远程部署模式
45

56
set -e
67

8+
REPO_BASE_URL="https://raw.githubusercontent.com/MigoXLab/webqa-agent"
9+
BRANCH="${WEBQA_BRANCH:-main}"
10+
711
echo "🚀 启动 WebQA Agent Docker 容器..."
812

9-
# 检查配置文件是否存在（优先检查统一配置文件）
10-
if [ -f "config/config.yaml" ]; then
11-
echo "✅ 找到统一配置文件: config/config.yaml"
13+
# 创建必要目录
14+
mkdir -p config logs reports
15+
16+
# 检查配置文件是否存在
17+
if [ ! -f "config.yaml" ] && [ ! -f "config/config.yaml" ]; then
18+
echo "❌ 配置文件不存在"
19+
echo "请先下载配置文件模板："
20+
if [ "$BRANCH" = "main" ]; then
21+
echo "curl -fsSL https://raw.githubusercontent.com/MigoXLab/webqa-agent/main/config/config.yaml.example -o config.yaml"
22+
else
23+
echo "curl -fsSL https://raw.githubusercontent.com/MigoXLab/webqa-agent/$BRANCH/config/config.yaml.example -o config.yaml"
24+
fi
25+
exit 1
26+
fi
27+
28+
# 下载 docker-compose.yml（如果不存在）
29+
if [ ! -f "docker-compose.yml" ]; then
30+
echo "📥 下载 docker-compose.yml..."
31+
curl -fsSL "$REPO_BASE_URL/$BRANCH/docker-compose.yml" -o docker-compose.yml || {
32+
echo "❌ 下载 docker-compose.yml 失败"
33+
exit 1
34+
}
35+
fi
36+
37+
# 确定配置文件路径
38+
if [ -f "config.yaml" ]; then
39+
CONFIG_FILE="config.yaml"
40+
echo "✅ 找到配置文件: config.yaml"
41+
elif [ -f "config/config.yaml" ]; then
42+
CONFIG_FILE="config/config.yaml"
43+
echo "✅ 找到配置文件: config/config.yaml"
1244
else
1345
echo "❌ 错误: 配置文件不存在"
14-
echo "请参考 README.md 创建配置文件:config/config.yaml"
1546
exit 1
1647
fi
1748

1849
# 简化配置验证
1950
echo "🔍 验证配置文件..."
2051

21-
# 检查 YAML 语法（优先使用 yq，其次使用 Python+PyYAML，如均不可用则跳过）
52+
# 检查 YAML 语法（优先使用 yq，其次使用 Python+PyYAML）
53+
YAML_STATUS=0
2254
if command -v yq >/dev/null 2>&1; then
23-
yq eval '.' config/config.yaml >/dev/null 2>&1
24-
YAML_STATUS=$?
55+
if ! yq eval '.' "$CONFIG_FILE" >/dev/null 2>&1; then
56+
echo "❌ 配置文件YAML语法错误 (yq检查)"
57+
YAML_STATUS=1
58+
fi
59+
elif python3 -c "import yaml" >/dev/null 2>&1; then
60+
if ! python3 -c "import yaml; yaml.safe_load(open('$CONFIG_FILE'))" >/dev/null 2>&1; then
61+
echo "❌ 配置文件YAML语法错误 (PyYAML检查)"
62+
YAML_STATUS=1
63+
fi
2564
else
26-
python3 - <<'PY'
27-
import sys, importlib.util, pathlib
28-
spec = importlib.util.find_spec('yaml')
29-
if spec is None:
30-
sys.exit(0) # 未安装 PyYAML，跳过检查
31-
import yaml
32-
try:
33-
yaml.safe_load(open('config/config.yaml'))
34-
except Exception:
35-
sys.exit(1)
36-
PY
37-
YAML_STATUS=$?
65+
echo "⚠️ 跳过YAML语法检查 (未安装yq或PyYAML)"
3866
fi
3967

4068
if [ $YAML_STATUS -ne 0 ]; then
41-
echo "❌ 配置文件YAML语法错误"
4269
exit 1
4370
fi
4471

4572
# 基本字段检查
46-
if ! grep -q "url:" config/config.yaml; then
73+
if ! grep -q "url:" "$CONFIG_FILE"; then
4774
echo "❌ 未找到 target.url 配置"
4875
exit 1
4976
fi
5077

51-
if ! grep -q "llm_config:" config/config.yaml; then
78+
if ! grep -q "llm_config:" "$CONFIG_FILE"; then
5279
echo "❌ 未找到 llm_config 配置"
5380
exit 1
5481
fi
5582

56-
if ! grep -q "test_config:" config/config.yaml; then
83+
if ! grep -q "test_config:" "$CONFIG_FILE"; then
5784
echo "❌ 未找到 test_config 配置"
5885
exit 1
5986
fi
6087

6188
# 检查是否有启用的测试 (支持 True/true)
62-
if ! grep -i "enabled: *true" config/config.yaml; then
89+
if ! grep -i "enabled: *true" "$CONFIG_FILE"; then
6390
echo "❌ 所有测试都已禁用，请至少启用一个测试项"
6491
exit 1
6592
fi
6693

6794
# 检查环境变量或配置文件中的API Key
68-
if [ -z "$OPENAI_API_KEY" ] && ! grep -q "api_key:" config/config.yaml; then
95+
if [ -z "$OPENAI_API_KEY" ] && ! grep -q "api_key:" "$CONFIG_FILE"; then
6996
echo "❌ LLM API Key 未配置 (需要环境变量 OPENAI_API_KEY 或配置文件中的 llm_config.api_key)"
7097
exit 1
7198
fi
@@ -76,29 +103,8 @@ echo "✅ 基本配置检查通过"
76103
mkdir -p logs reports
77104

78105
# 启动容器
79-
case "$1" in
80-
"--build"|"-b")
81-
echo "📦 重新构建并启动容器..."
82-
docker-compose up --build
83-
;;
84-
"--local"|"-l")
85-
echo "🚀 使用本地镜像启动容器..."
86-
docker-compose up
87-
;;
88-
"")
89-
echo "🚀 智能启动容器..."
90-
echo "💡 提示: --build 重新构建 | --local 使用本地镜像"
91-
docker-compose up
92-
;;
93-
*)
94-
echo "❌ 无效参数: $1"
95-
echo "用法: ./start.sh [--build|--local]"
96-
echo " --build, -b 重新构建并启动"
97-
echo " --local, -l 使用本地镜像启动"
98-
echo " (无参数) 智能启动"
99-
exit 1
100-
;;
101-
esac
106+
echo "🚀 启动容器..."
107+
docker-compose up
102108

103109
echo "✅ 容器启动完成！"
104110
echo "📋 查看日志: docker-compose logs -f"

‎webqa_agent/llm/llm_api.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,12 @@ async def _call_openai(self, messages, temperature=None, top_p=None):
9999

100100
completion = await self.client.chat.completions.create(**create_kwargs)
101101
content = completion.choices[0].message.content
102+
logging.debug(f"LLM API response: {content}")
102103
# Clean response if it's wrapped in JSON code blocks
103104
content = self._clean_response(content)
104105
return content
105106
except Exception as e:
106-
logging.error(f"Error while calling OpenAI API: {e}")
107+
logging.error(f"Error while calling LLM API: {e}")
107108
raise ValueError(f"{str(e)}")
108109

109110
def _clean_response(self, response):

0 commit comments

Comments
 (0)