Compare commits
12 Commits
e1322c97cf
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 7c50a1b091 | |||
| 750fbdc79e | |||
| fb5638dae8 | |||
| 3280bac8db | |||
| a6b4a454f2 | |||
| 735117b9bf | |||
| ab1a2546f8 | |||
| b0d1d94f74 | |||
| d1582d1bb9 | |||
| a9977a6d21 | |||
| 9cb2780fd6 | |||
| 9fedca93d6 |
@@ -14,9 +14,9 @@ jobs:
|
||||
image: gitea/runner-images:ubuntu-latest
|
||||
steps:
|
||||
- name: 拉取代码
|
||||
uses: https://devstar.cn/actions/checkout@v4
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
fetch-depth: 1
|
||||
|
||||
- name: 安装依赖
|
||||
working-directory:
|
||||
@@ -32,21 +32,17 @@ jobs:
|
||||
|
||||
- name: 构建 Docker 镜像
|
||||
run: |
|
||||
docker build -t devstar-docs:${{ gitea.sha }} .
|
||||
docker build -t devstar.cn/devstar/devstar-docs:latest .
|
||||
|
||||
- name: 登录 Docker Registry 并推送镜像
|
||||
if: github.event_name != 'pull_request'
|
||||
run: |
|
||||
echo "${{ secrets.DOCKER_REGISTRY_PASSWORD }}" | docker login -u ${{ secrets.DOCKER_REGISTRY_USERNAME }} ${{ vars.DOCKER_REGISTRY_ADDRESS }} --password-stdin
|
||||
docker tag devstar-docs:${{ gitea.sha }} ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:${{ gitea.sha }}
|
||||
docker tag devstar-docs:${{ gitea.sha }} ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:latest
|
||||
docker push ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:${{ gitea.sha }}
|
||||
docker push ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:latest
|
||||
docker push devstar.cn/devstar/devstar-docs:latest
|
||||
|
||||
- name: 📝 Update mengning.com.cn（通过删除/创建 Application CRD）
|
||||
if: github.event_name != 'pull_request'
|
||||
env:
|
||||
DOCKER_REGISTRY_ADDRESS: ${{ vars.DOCKER_REGISTRY_ADDRESS }}
|
||||
DOCKER_REPOSITORY_ARTIFACT: ${{ vars.DOCKER_REPOSITORY_ARTIFACT }}
|
||||
DOCKER_IMAGE_TAG: ${{ gitea.sha }}
|
||||
TLS_CERTIFICATE: ${{ secrets.TLS_CERTIFICATE }}
|
||||
TLS_PRIVATE_KEY: ${{ secrets.TLS_PRIVATE_KEY }}
|
||||
run: |
|
||||
@@ -68,12 +64,14 @@ jobs:
|
||||
--dry-run=client -o yaml | kubectl apply -f -
|
||||
rm -f /tmp/tls.crt /tmp/tls.key
|
||||
|
||||
# 替换 Application YAML 中的镜像地址变量并应用
|
||||
sed "s|\${DOCKER_REGISTRY_ADDRESS}|${DOCKER_REGISTRY_ADDRESS}|g; s|\${DOCKER_REPOSITORY_ARTIFACT}|${DOCKER_REPOSITORY_ARTIFACT}|g; s|\${DOCKER_IMAGE_TAG}|${DOCKER_IMAGE_TAG}|g" \
|
||||
.gitea/workflows/application.yaml > /tmp/application-crd.yaml
|
||||
|
||||
# 删除旧的 Application CRD（如果存在，忽略错误）
|
||||
kubectl delete application mengningsoftware -n web-servers --ignore-not-found=true || true
|
||||
|
||||
# 创建新的 Application CRD
|
||||
kubectl apply -f /tmp/application-crd.yaml
|
||||
kubectl apply -f deploy.yaml
|
||||
|
||||
- name: Clean Environment
|
||||
if: always()
|
||||
run: |
|
||||
docker rmi devstar.cn/devstar/devstar-docs:latest || true
|
||||
docker builder prune -f || true
|
||||
@@ -93,138 +93,38 @@ function sidebarDevStar(): DefaultTheme.SidebarItem[] {
|
||||
{ text: 'app.ini配置文件', link: 'src/devstar/install/app-ini' },
|
||||
]
|
||||
} as any,
|
||||
{
|
||||
text: '管理',
|
||||
collapsible: true, // 使整个组可折叠
|
||||
collapsed: true, // 默认展开
|
||||
items: [
|
||||
{ text: '命令行', link: 'https://docs.gitea.com/zh-cn/administration/command-line' },
|
||||
{ text: '认证', link: 'https://docs.gitea.com/zh-cn/administration/authentication' },
|
||||
{ text: '环境变量清单', link: 'https://docs.gitea.com/zh-cn/administration/environment-variables' },
|
||||
{ text: '备份与恢复', link: 'https://docs.gitea.com/zh-cn/administration/backup-and-restore' },
|
||||
{ text: 'Email设置', link: 'https://docs.gitea.com/zh-cn/administration/email-setup' },
|
||||
{ text: 'Git LFS设置', link: 'https://docs.gitea.com/zh-cn/administration/git-lfs-setup' },
|
||||
{ text: 'HTTPS配置', link: 'https://docs.gitea.com/zh-cn/administration/https-setup' },
|
||||
{ text: '设置Fail2ban', link: 'https://docs.gitea.com/zh-cn/administration/fail2ban-setup' },
|
||||
{ text: '反向代理', link: 'https://docs.gitea.com/zh-cn/administration/reverse-proxies' },
|
||||
{ text: '嵌入资源提取工具', link: 'https://docs.gitea.com/zh-cn/administration/cmd-embedded' },
|
||||
{ text: '配置说明', link: 'https://docs.gitea.com/zh-cn/administration/config-cheat-sheet' },
|
||||
{ text: '日志配置', link: 'https://docs.gitea.com/zh-cn/administration/logging-config' },
|
||||
{ text: '邮件模板', link: 'https://docs.gitea.com/zh-cn/administration/mail-templates' },
|
||||
{ text: '仓库索引器', link: 'https://docs.gitea.com/zh-cn/administration/repo-indexer' },
|
||||
{ text: 'GPG提交签名', link: 'https://docs.gitea.com/zh-cn/administration/signing' },
|
||||
{ text: '外部渲染器', link: 'https://docs.gitea.com/zh-cn/administration/external-renderers' },
|
||||
{ text: '搜索引擎索引', link: 'https://docs.gitea.com/zh-cn/administration/search-engines-indexation' },
|
||||
{ text: '自定义Gitea配置', link: 'https://docs.gitea.com/zh-cn/administration/customizing-gitea' },
|
||||
{ text: '添加法律页面', link: 'https://docs.gitea.com/zh-cn/administration/adding-legal-pages' }
|
||||
]
|
||||
} as any,
|
||||
{
|
||||
text: '使用',
|
||||
collapsible: true, // 使整个组可折叠
|
||||
collapsed: true, // 默认展开
|
||||
items: [
|
||||
{ text: 'devcontainer', link: 'src/devstar/usage/quick-start-with-ai' },
|
||||
{
|
||||
text: 'Actions',
|
||||
collapsible: true, // 使整个组可折叠
|
||||
collapsed: false, // 默认展开
|
||||
items: [
|
||||
{ text: 'Overview', link: 'https://docs.gitea.com/zh-cn/usage/actions/overview' },
|
||||
{ text: '快速入门', link: 'https://docs.gitea.com/zh-cn/usage/actions/quickstart' },
|
||||
{ text: '与GitHub Actions的对比', link: 'https://docs.gitea.com/zh-cn/usage/actions/comparison' },
|
||||
{ text: 'Act Runner', link: 'https://docs.gitea.com/zh-cn/usage/actions/act-runner' },
|
||||
{ text: '变量', link: 'https://docs.gitea.com/zh-cn/usage/actions/actions-variables' },
|
||||
{ text: 'Gitea Actions设计', link: 'https://docs.gitea.com/zh-cn/usage/actions/design' },
|
||||
{ text: '密钥管理', link: 'https://docs.gitea.com/zh-cn/usage/actions/secrets' },
|
||||
{ text: 'Gitea Actions常见问题解答', link: 'https://docs.gitea.com/zh-cn/usage/actions/faq' },
|
||||
{ text: 'Badge', link: 'https://docs.gitea.com/zh-cn/usage/actions/badge' }
|
||||
{ text: '快速入门AI+', link: 'src/devstar/usage/quick-start-with-ai' },
|
||||
{
|
||||
text: 'CI/CD工作流Actions',
|
||||
collapsible: true, // 使整个组可折叠
|
||||
collapsed: false, // 默认展开
|
||||
items: [
|
||||
{ text: 'Overview', link: 'src/devstar/actions/overview' },
|
||||
{ text: '快速入门', link: 'src/devstar/actions/quickstart' },
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '软件包',
|
||||
text: '开发容器DevContainer',
|
||||
collapsible: true, // 使整个组可折叠
|
||||
collapsed: true, // 默认展开
|
||||
collapsed: false, // 默认展开
|
||||
items: [
|
||||
{ text: '软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/overview' },
|
||||
{ text: 'Alpine 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/alpine' },
|
||||
{ text: 'Arch package registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/arch' },
|
||||
{ text: 'Cargo 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cargo' },
|
||||
{ text: 'Chef 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/chef' },
|
||||
{ text: '存储', link: 'https://docs.gitea.com/zh-cn/usage/packages/storage' },
|
||||
{ text: 'Composer 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/composer' },
|
||||
{ text: 'Conan 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conan' },
|
||||
{ text: 'Conda 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/conda' },
|
||||
{ text: '容器注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/container' },
|
||||
{ text: 'CRAN 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/cran' },
|
||||
{ text: 'Go 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/go' },
|
||||
{ text: 'Helm Chart 注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/helm' },
|
||||
{ text: 'Maven 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/maven' },
|
||||
{ text: 'NPM Package Registry', link: 'https://docs.gitea.com/zh-cn/usage/packages/npm' },
|
||||
{ text: 'NuGet 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/nuget' },
|
||||
{ text: 'Pub 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pub' },
|
||||
{ text: 'PyPI 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/pypi' },
|
||||
{ text: 'RPM 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/packages/rpm' },
|
||||
{ text: 'RubyGems 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/rubygems' },
|
||||
{ text: 'Swift 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/swift' },
|
||||
{ text: 'Vagrant 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/vagrant' },
|
||||
{ text: '通用软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/generic' },
|
||||
{ text: 'Debian 软件包注册表', link: 'https://docs.gitea.com/zh-cn/usage/packages/debian' }
|
||||
{ text: 'Overview', link: 'src/devstar/devcontainer/overview' },
|
||||
{ text: '快速入门', link: 'src/devstar/devcontainer/quickstart' },
|
||||
]
|
||||
},
|
||||
{ text: 'AGit', link: 'https://docs.gitea.com/zh-cn/usage/agit' },
|
||||
{ text: '个人资料 README', link: 'https://docs.gitea.com/zh-cn/usage/profile-readme' },
|
||||
{ text: 'Blame File View', link: 'https://docs.gitea.com/zh-cn/usage/blame' },
|
||||
{ text: '邮件接收', link: 'https://docs.gitea.com/zh-cn/usage/incoming-email' },
|
||||
{ text: '标签', link: 'https://docs.gitea.com/zh-cn/usage/labels' },
|
||||
{ text: '合并请求', link: 'https://docs.gitea.com/zh-cn/usage/pull-request' },
|
||||
{ text: '权限', link: 'https://docs.gitea.com/zh-cn/usage/permissions' },
|
||||
{ text: '模板仓库', link: 'https://docs.gitea.com/zh-cn/usage/template-repositories' },
|
||||
{ text: '从模板创建工单与合并请求', link: 'https://docs.gitea.com/zh-cn/usage/issue-pull-request-templates' },
|
||||
{ text: '自动链接引用', link: 'https://docs.gitea.com/zh-cn/usage/automatically-linked-references' },
|
||||
{ text: '合并消息模板', link: 'https://docs.gitea.com/zh-cn/usage/merge-message-template' },
|
||||
{ text: '推送', link: 'https://docs.gitea.com/zh-cn/usage/push' },
|
||||
{ text: 'Blocking a user', link: 'https://docs.gitea.com/zh-cn/usage/blocking-user' },
|
||||
{ text: '克隆过滤器 (部分克隆)', link: 'https://docs.gitea.com/zh-cn/usage/clone-filters' },
|
||||
{ text: 'Code Owners', link: 'https://docs.gitea.com/zh-cn/usage/code-owners' },
|
||||
{ text: 'Webhooks', link: 'https://docs.gitea.com/zh-cn/usage/webhooks' },
|
||||
{ text: 'Migration', link: 'https://docs.gitea.com/zh-cn/usage/migration' },
|
||||
{ text: '受保护的标签', link: 'https://docs.gitea.com/zh-cn/usage/protected-tags' },
|
||||
{ text: '仓库镜像', link: 'https://docs.gitea.com/zh-cn/usage/repo-mirror' },
|
||||
{ text: 'Markdown', link: 'https://docs.gitea.com/zh-cn/usage/markdown' },
|
||||
{ text: 'Multi-factor Authentication (MFA)', link: 'https://docs.gitea.com/zh-cn/usage/multi-factor-authentication' }
|
||||
]
|
||||
} as any,
|
||||
{
|
||||
text: '开发',
|
||||
text: '更多帮助',
|
||||
collapsible: true, // 使整个组可折叠
|
||||
collapsed: true, // 默认展开
|
||||
collapsed: false, // 默认展开
|
||||
items: [
|
||||
{ text: '玩转 Gitea', link: 'https://docs.gitea.com/zh-cn/development/hacking-on-gitea' },
|
||||
{ text: 'API 使用指南', link: 'https://docs.gitea.com/zh-cn/development/api-usage' },
|
||||
{ text: 'OAuth2 提供者', link: 'https://docs.gitea.com/zh-cn/development/oauth2-provider' },
|
||||
{ text: '迁移接口', link: 'https://docs.gitea.com/zh-cn/development/migrations-interfaces' },
|
||||
{ text: '集成', link: 'https://docs.gitea.com/zh-cn/development/integrations' }
|
||||
]
|
||||
} as any,
|
||||
{
|
||||
text: '贡献',
|
||||
collapsible: true, // 使整个组可折叠
|
||||
collapsed: true, // 默认展开
|
||||
items: [
|
||||
{ text: '后端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-backend' },
|
||||
{ text: '前端开发指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-frontend' },
|
||||
{ text: '重构指南', link: 'https://docs.gitea.com/zh-cn/contributing/guidelines-refactoring' },
|
||||
{ text: '本地化', link: 'https://docs.gitea.com/zh-cn/contributing/localization' }
|
||||
]
|
||||
} as any,
|
||||
{
|
||||
text: '帮助',
|
||||
collapsible: true, // 使整个组可折叠
|
||||
collapsed: true, // 默认展开
|
||||
items: [
|
||||
{ text: '常见问题', link: 'https://docs.gitea.com/zh-cn/help/faq' },
|
||||
{ text: '支持选项', link: 'https://docs.gitea.com/zh-cn/help/support' },
|
||||
{ text: 'Gitea常见问题', link: 'https://docs.gitea.com/zh-cn/help/faq' },
|
||||
]
|
||||
} as any,
|
||||
]
|
||||
|
||||
@@ -44,7 +44,7 @@ spec:
|
||||
targetPort: http
|
||||
template:
|
||||
type: stateless
|
||||
image: ${DOCKER_REGISTRY_ADDRESS}/${DOCKER_REPOSITORY_ARTIFACT}:${DOCKER_IMAGE_TAG}
|
||||
image: devstar.cn/devstar/devstar-docs:latest
|
||||
ports:
|
||||
- name: http
|
||||
port: 80
|
||||
@@ -40,51 +40,36 @@ repo sync -j16
|
||||
cd android-14.0.0_r2
|
||||
source build/envsetup.sh # 初始化环境
|
||||
lunch aosp_arm-eng # 选择目标配置
|
||||
make # 执行单机编译，编译成功后可以看到：
|
||||
make # 执行单机编译
|
||||
```
|
||||
编译成功后可以看到：
|
||||
```
|
||||
[ 99% 130084/130093] out/host/linux-x86/bin/resourceshrinker --output out/soong/.intermediates/frameworks/base/packages/SystemUI/SystemUI
|
||||
Shrunken apk stored in:
|
||||
out/soong/.intermediates/frameworks/base/packages/SystemUI/SystemUI/android_common/SystemUI-unsigned.apk.proto.out.apk
|
||||
[100% 130093/130093] Target vbmeta image: out/target/product/generic/vbmeta.img
|
||||
|
||||
#### build completed successfully (02:20:12 (hh:mm:ss)) ####
|
||||
|
||||
```
|
||||
```
|
||||
[19:20:05.430], pending/wanted: 4, ready: 1, running: 0
|
||||
|
||||
|
||||
#### build completed successfully (02:26:51 (hh:mm:ss)) ####
|
||||
|
||||
|
||||
real 146m51.385s
|
||||
user 1327m35.812s
|
||||
sys 78m2.153s
|
||||
root@lab1:/home/lab1/android-14.0.0_r2#
|
||||
```
|
||||
|
||||
|
||||
|
||||
### 配置AOSP项目开启ShareBuild模式
|
||||
|
||||
* 将.sharebuild.yml 复制到 AOSP 根目录
|
||||
* 到 AOSP 项目根目录下执行 setup_sharebuild_forAOSP14.sh 配置ShareBuild分布式编译
|
||||
```
|
||||
cd android-14.0.0_r2
|
||||
cp /etc/ninja2/aosp14/.sharebuild.yml ./
|
||||
```
|
||||
|
||||
* 进入AOSP14项目根目录，替换 AOSP 内部 ninja 为 android_ninja
|
||||
```
|
||||
cp /usr/bin/android_ninja prebuilts/build-tools/linux-x86/bin/ninja
|
||||
```
|
||||
|
||||
* 开启ShareBuild模式，然后进行分布式编译。
|
||||
项目根目录下创建ninja2.conf 文件如下即可开启ShareBuild模式：
|
||||
```
|
||||
sharebuid:true
|
||||
/etc/ninja2/aosp14/setup_sharebuild_forAOSP14.sh
|
||||
```
|
||||
|
||||
* 在项目根目录下执行分布式编译
|
||||
|
||||
```bash
|
||||
su # 切换到 root 关闭沙箱
|
||||
source build/envsetup.sh # 初始化环境
|
||||
lunch aosp_arm-eng # 选择目标配置
|
||||
make # 执行分布式编译，编译成功后可以看到：
|
||||
make # 执行分布式编译
|
||||
```
|
||||
编译成功后可以看到：
|
||||
|
||||
* 客户端节点：
|
||||
```
|
||||
[ShareBuild] Command will be executed REMOTELY
|
||||
@@ -101,7 +86,7 @@ stdout: , stderr:
|
||||
real 102m16.362s
|
||||
user 1074m56.673s
|
||||
sys 64m22.863s
|
||||
root@lab1:/home/lab1/android-14.0.0_r2#
|
||||
|
||||
```
|
||||
* 服务端节点sharebuild部分日志：
|
||||
```
|
||||
|
||||
56
src/devstar/actions/overview.md
Normal file
56
src/devstar/actions/overview.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# DevStar CI/CD工作流 Actions Overview
|
||||
|
||||
DevStar基于Gitea Actions开发了开箱即用的CI/CD工作流解决方案, 兼容Github Actions生态系统。
|
||||
|
||||
> - 本站中Actions是指DevStar开箱即用的CI/CD工作流解决方案，从不同方面兼容Gitea Actions和Github Actions。
|
||||
> - 本站中actions/action是指Actions要使用的脚本/插件，比如"actions/checkout@v4" 或 "kekxv/AiReviewPR@v0.0.6"。
|
||||
|
||||
## Actions的安装配置方法
|
||||
|
||||
- DevStar安装过程中会默认启动一个全局的Actions Runner；
|
||||
- 一键启动Actions Runner
|
||||
|
||||
在项目设置、用户设置、组织设置和后台管理中，如果当前用户有创建Actions Runner的权限，可在工作流Actions板块下点击【创建新运行器】，找到【一键启动运行器】可以创建相应作用范围的Actions Runner。
|
||||
|
||||
- 手工启动Actions Runner
|
||||
|
||||
在项目设置、用户设置、组织设置和后台管理中，可以在工作流Actions板块下点击【创建新运行器】，可以复制Registration Token。
|
||||
|
||||
> 不同位置复制的Registration Token创建的Actions Runner有不同的作用范围。
|
||||
|
||||
```
|
||||
$ docker run --name devstar-runner -d -v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-e GITEA_INSTANCE_URL=${YOUR_DEVSTAR_URL} \
|
||||
-e GITEA_RUNNER_REGISTRATION_TOKEN=${YOUR_DEVSTAR_RUNNER_REGISTRATION_TOKEN} \
|
||||
devstar.cn/devstar/act_runner:latest
|
||||
```
|
||||
|
||||
## 使用actions短链接的好处
|
||||
|
||||
在DevStar CI/CD工作流配置文件中（如.gitea/workflows/ci-cd.yaml）使用不包含域名的actions短链接，DevStar会智能判断当前平台上是否有相同名称的仓库或镜像仓库，如有则使用当前平台的仓库，没有则默认使用github.com上的仓库。
|
||||
|
||||
```
|
||||
- name: 🔍 Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: AI Review code
|
||||
uses: kekxv/AiReviewPR@v0.0.6
|
||||
|
||||
- name: Report Test Results
|
||||
if: always() && github.event_name == 'pull_request'
|
||||
uses: actions/github-script@v6
|
||||
```
|
||||
|
||||
> 类似以上actions短链接仓库，如果在当前DevStar平台上创建相应的镜像仓库，可以智能选择拉取本平台上的仓库，从而避免github.com网络访问问题影响CI/CD工作流的执行。
|
||||
|
||||
## 调试CI/CD工作流
|
||||
|
||||
DevStar已支持在线调试CI/CD工作流配置文件脚本，调试方法如下：
|
||||
|
||||
- 在项目仓库页面点击【工作流/Actions】，然后选择进入某个工作流，右上角【编辑并运行工作流】即可修改脚本再次执行，运行成功后可以直接提交到对应的仓库分支。
|
||||
|
||||
> 本地配置调试CI/CD工作流的方法参见：
|
||||
> - https://cli.github.com
|
||||
> - [GitHub Local Actions](https://sanjulaganepola.github.io/github-local-actions-docs/)
|
||||
> - https://nektosact.com/
|
||||
|
||||
3
src/devstar/actions/quickstart.md
Normal file
3
src/devstar/actions/quickstart.md
Normal file
@@ -0,0 +1,3 @@
|
||||
|
||||
# DevStar CI/CD工作流 Actions 快速入门
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
|
||||
|
||||
# DevStar AI+ DevOps
|
||||
|
||||
DevStar AI+ DevOps 是一个完整的AI驱动研发平台解决方案，通过集成 DevStar平台、代码大语言模型、Gitea MCP Server和 AI Code Tools（Cursor、Claude Code、iFlow等），为开发者提供智能化研发支撑体系。
|
||||
@@ -93,11 +92,11 @@ jobs:
|
||||
//如果用ai token 则需配置
|
||||
//ai_token: ${{ vars.AI_TOKEN }}
|
||||
```
|
||||
然后在 DevStar（项目设置 / 用户设置 / 后台管理）里设置变量：
|
||||
然后在 DevStar 平台上您的项目仓库【设置 > 工作流】 里设置变量或密钥：
|
||||
|
||||
- `vars.MODEL`：填入 **第二步中的模型名**，例如 `qwen2.5-coder:32b`
|
||||
- `vars.OLLAMA_HOST`：填入 **第二步中得到的模型服务地址** 例如 `http://172.16.94.26:11434`
|
||||
- `vars.AI_TOKEN`：填入 **第二步中第三方获取的token**
|
||||
- `vars.AI_TOKEN`：填入 **第二步中第三方获取的API Key token**
|
||||
|
||||
#### 安装配置MCP Server
|
||||
|
||||
@@ -145,24 +144,28 @@ jobs:
|
||||
|
||||
获取方式：
|
||||
|
||||
1. 登录 DevStar（`GITEA_HOST` 对应的网站）
|
||||
2. 进入：**设置 → 应用 **
|
||||
3. 点击「生成新的令牌」，给予仓库读取等必要权限
|
||||
1. 登录 DevStar 平台 （`GITEA_HOST` 对应的网站）
|
||||
2. 进入：右上角用户 【设置 > 应用】中
|
||||
3. 点击「生成新的令牌」，命名令牌并给予仓库读取等必要权限
|
||||
4. 复制生成的一串字符串，这就是你的 `gitea_token`
|
||||
|
||||
#### 配置AI IDE/CLI使用私有大模型及MCP Server
|
||||
#### 配置 AI IDE/CLI 使用 LLM 及 MCP Server
|
||||
|
||||
* Copilot，点击提示框里的“管理模型”，选择ollama；将mcp配置添加到 .vscode/mcp.json下
|
||||
- **LLM**
|
||||
- 使用第三方 API/云端模型（OpenAI/Anthropic/Azure/Gemini）
|
||||
- **Cursor**：在模型设置中选择对应 Provider，配置 **API Key / Base URL / Model**
|
||||
- **Continue**：Add Chat model 选择对应 Provider，配置 **API Key / Base URL / Model**
|
||||
- **Copilot**：在“管理模型”中选择 **Copilot 支持的云端模型**（若需使用自带 Key 的第三方，一般用 Cursor/Continue 接入更直接）
|
||||
- 使用本地/私有部署（Ollama / 内网 LLM）
|
||||
- **Copilot**：在“管理模型”中选择 **ollama**
|
||||
- **Continue**：Add Chat model → Provider 选择 **ollama**
|
||||
- **Cursor**：若 LLM 在内网且 Cursor 不支持直连，需要做**反向代理/企业网关**提供公网可访问的 **Base URL** 再接入
|
||||
- **MCP Server（与 LLM 选择无关）**
|
||||
- **Copilot（VS Code）**：将 MCP 配置添加到 **.vscode/mcp.json**
|
||||
- **Cursor**：Cursor Settings → Tools & MCP → New MCP Server，将 MCP 配置写入 **mcp.json**
|
||||
- **Continue**：Settings → Tools → MCP Servers 配置 YAML ，或复用 Cursor 的 MCP 配置：将 **mcp.json** 放到 **.continue/mcpServers/mcp.json**
|
||||
|
||||
* Cursor，不支持内网地址的私有部署大模型，需要做反向代理使用公网可以访问的地址；点击Cursor Settings -> Tools & MCP
|
||||
|
||||
-> New MCP Server 将mcp配置添加到mcp.json中
|
||||
|
||||
* Continue，点击Add Chat model，Provider选择ollama；设置->Tools->MCP Servers配置yaml文件
|
||||
|
||||
也可以将cursor的json文件放到.continue/mcpServers/mcp.json中
|
||||
|
||||
* ...
|
||||
|
||||
## 🚀 DevStar AI+ DevOps演示
|
||||
|
||||
@@ -170,7 +173,7 @@ jobs:
|
||||
|
||||
### 创建一个项目
|
||||
|
||||
使用ai-develops项目模板创建项目
|
||||
点击右上角创建仓库->DevStar模板中选择Devstar.cn/template/ai-develops
|
||||
|
||||
|
||||
|
||||
@@ -186,7 +189,7 @@ jobs:
|
||||
|
||||
3.请为这次修复 issue #1 的改动补充或更新测试代码，遵循项目的现有测试风格，并说明每个测试在验证什么行为。
|
||||
|
||||
|
||||
|
||||
|
||||
### 提交PR
|
||||
|
||||
|
||||
4
src/devstar/devcontainer/overview.md
Normal file
4
src/devstar/devcontainer/overview.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# DevStar DevContainer Overview
|
||||
|
||||
|
||||
|
||||
3
src/devstar/devcontainer/quickstart.md
Normal file
3
src/devstar/devcontainer/quickstart.md
Normal file
@@ -0,0 +1,3 @@
|
||||
|
||||
# DevStar DevContainer 快速入门
|
||||
|
||||
@@ -1,63 +1,549 @@
|
||||
---
|
||||
outline: deep
|
||||
weight: 6
|
||||
---
|
||||
|
||||
# MCP Server
|
||||
|
||||
### 快速安装配置MCP Server
|
||||
DevStar 内置了 MCP (Model Context Protocol) Server，为 AI 编程助手提供对 DevStar 平台的完整访问能力，包括代码仓库、Issues、Pull Requests、Actions 等所有核心功能。
|
||||
|
||||
在 VS Code 中使用，要快速安装，请使用如下安装按钮。
|
||||
## 概述
|
||||
|
||||
[](https://insiders.vscode.dev/redirect/mcp/install?name=gitea&inputs=[{%22id%22:%22gitea_token%22,%22type%22:%22promptString%22,%22description%22:%22Gitea%20Personal%20Access%20Token%22,%22password%22:true}]&config={%22command%22:%22docker%22,%22args%22:[%22run%22,%22-i%22,%22--rm%22,%22-e%22,%22GITEA_ACCESS_TOKEN%22,%22docker.gitea.com/gitea-mcp-server%22],%22env%22:{%22GITEA_ACCESS_TOKEN%22:%22${input:gitea_token}%22}}) [](https://insiders.vscode.dev/redirect/mcp/install?name=gitea&inputs=[{%22id%22:%22gitea_token%22,%22type%22:%22promptString%22,%22description%22:%22Gitea%20Personal%20Access%20Token%22,%22password%22:true}]&config={%22command%22:%22docker%22,%22args%22:[%22run%22,%22-i%22,%22--rm%22,%22-e%22,%22GITEA_ACCESS_TOKEN%22,%22docker.gitea.com/gitea-mcp-server%22],%22env%22:{%22GITEA_ACCESS_TOKEN%22:%22${input:gitea_token}%22}}&quality=insiders)
|
||||
DevStar MCP Server 是一个基于 [MCP 协议](https://modelcontextprotocol.io) 的服务端实现，允许 AI 编程助手（如 Claude Code、Cursor、VS Code Copilot）通过标准化的方式访问 DevStar 平台的各项功能。
|
||||
|
||||
也可以在项目中添加到 .vscode/mcp.json 文件如下：
|
||||
### 核心特性
|
||||
|
||||
- **内置集成**：无需额外部署，DevStar 平台直接提供 MCP Server
|
||||
- **完整功能覆盖**：支持仓库、Issue、PR、Actions、Wiki 等所有核心功能
|
||||
- **标准协议**：基于 MCP 2024-11-05 协议规范
|
||||
- **安全认证**：支持 Bearer Token 认证
|
||||
- **HTTP 传输**：通过标准 HTTP POST 请求进行通信
|
||||
|
||||
## 架构设计
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ MCP 客户端 │
|
||||
│ (Claude Code / Cursor / VS Code Copilot) │
|
||||
└─────────────────────┬───────────────────────────────────┘
|
||||
│ HTTP POST /api/mcp
|
||||
│ Authorization: Bearer <token>
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ DevStar MCP Server │
|
||||
│ • JSON-RPC 消息处理 │
|
||||
│ • 方法路由: initialize/tools/list/tools/call │
|
||||
│ • 工具执行调度 │
|
||||
└─────────────────────┬───────────────────────────────────┘
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ 工具实现层 (10 大类，共 89 个工具) │
|
||||
│ ┌──────────┬──────────┬─────────┬─────────┬────────┐ │
|
||||
│ │ actions │ repo │ issue │ pull │ label │ │
|
||||
│ │ (27个) │ (16个) │ (11个) │ (4个) │ (9个) │ │
|
||||
│ └──────────┴──────────┴─────────┴─────────┴────────┘ │
|
||||
│ ┌──────────┬──────────┬─────────┬─────────┬────────┐ │
|
||||
│ │ milestone│ wiki │ release │user/ │ org │ │
|
||||
│ │ (5个) │ (6个) │ (5个) │search │ actions │ │
|
||||
│ │ │ │ │ (5个) │ (12个) │ │
|
||||
│ └──────────┴──────────┴─────────┴─────────┴────────┘ │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
## 快速开始
|
||||
|
||||
DevStar MCP Server 提供开箱即用的体验，通过 DevStar VS Code 插件自动配置，无需手动配置。
|
||||
|
||||
### 使用 DevStar VS Code 插件（推荐）
|
||||
|
||||
**这是最简单的方式，完全自动化配置。**
|
||||
|
||||
1. **安装 DevStar VS Code 插件**
|
||||
- 在 VS Code 扩展市场搜索 "DevStar"
|
||||
- 点击安装
|
||||
|
||||
2. **登录 DevStar 账号**
|
||||
- 点击 VS Code 左侧的 DevStar 图标
|
||||
- 输入 DevStar 平台地址（如 `https://devstar.cn`）
|
||||
- 输入用户名和访问令牌
|
||||
|
||||
3. **自动配置 MCP Server**
|
||||
- 登录后，插件会自动检测运行环境并配置 MCP Server
|
||||
- 容器环境：配置到容器内的 MCP 配置文件（路径因环境而异）
|
||||
- 本地环境：配置到本地 MCP 配置文件（路径因 IDE 而异）
|
||||
- 配置内容自动包含正确的认证令牌和 API 地址
|
||||
|
||||
4. **开始使用**
|
||||
- 在 AI 助手中直接对话
|
||||
- AI 助手可以访问 DevStar 平台的所有功能
|
||||
|
||||
### 手动配置（高级用户）
|
||||
|
||||
如果你需要手动配置（不使用 DevStar VS Code 插件），请按照以下步骤：
|
||||
|
||||
#### 1. 获取访问令牌
|
||||
|
||||
在 DevStar 平台创建 Personal Access Token：
|
||||
|
||||
1. 登录 DevStar 平台
|
||||
2. 进入 **设置** → **应用** → **访问令牌**
|
||||
3. 点击 **生成新令牌**
|
||||
4. 设置令牌名称
|
||||
5. 选择权限范围（建议至少包含 `read:user`、`read:repository`、`write:issue` 等）
|
||||
6. 复制生成的令牌（注意：令牌只显示一次）
|
||||
|
||||
#### 2. 根据你的 AI 编程环境配置
|
||||
|
||||
**Claude Code**
|
||||
|
||||
配置文件位置：
|
||||
- macOS/Linux: `~/.claude/mcp_servers.json`
|
||||
- Windows: `%APPDATA%\Claude\mcp_servers.json`
|
||||
|
||||
```json
|
||||
{
|
||||
"inputs": [
|
||||
{
|
||||
"type": "promptString",
|
||||
"id": "gitea_token",
|
||||
"description": "Gitea 个人访问令牌",
|
||||
"password": true
|
||||
}
|
||||
],
|
||||
"servers": {
|
||||
"gitea-mcp": {
|
||||
"command": "docker",
|
||||
"args": [
|
||||
"run",
|
||||
"-i",
|
||||
"--rm",
|
||||
"-e",
|
||||
"GITEA_HOST",
|
||||
"-e",
|
||||
"GITEA_ACCESS_TOKEN",
|
||||
"docker.gitea.com/gitea-mcp-server"
|
||||
],
|
||||
"env": {
|
||||
"GITEA_HOST": "<Your Gitea Host>",
|
||||
"GITEA_ACCESS_TOKEN": "${input:gitea_token}"
|
||||
"mcpServers": {
|
||||
"devstar": {
|
||||
"type": "http",
|
||||
"url": "http://<YOUR_DEVSTAR_HOST>/api/mcp",
|
||||
"headers": {
|
||||
"Authorization": "Bearer <YOUR_TOKEN>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### MCP Server使用注意事项
|
||||
**Cursor**
|
||||
|
||||
#### Copilot（VS Code）
|
||||
配置文件位置：
|
||||
- macOS/Linux: `~/.cursor/mcp.json`
|
||||
- Windows: `%USERPROFILE%\.cursor\mcp.json`
|
||||
|
||||
- 配置放在 `.vscode/mcp.json`。重启 VS Code → Copilot 自动加载。
|
||||
<!-- TODO: 添加 Cursor 的详细配置说明 -->
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"devstar": {
|
||||
"type": "http",
|
||||
"url": "http://<YOUR_DEVSTAR_HOST>/api/mcp",
|
||||
"headers": {
|
||||
"Authorization": "Bearer <YOUR_TOKEN>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Windsurf**
|
||||
|
||||
<!-- TODO: 添加 Windsurf 的配置说明 -->
|
||||
|
||||
**VS Code Copilot**
|
||||
|
||||
VS Code Copilot 的 MCP 配置文件位置：
|
||||
- **macOS**: `~/Library/Application Support/Code/User/mcp.json`
|
||||
- **Windows**: `%APPDATA%/Code/User/mcp.json`
|
||||
|
||||
配置方式：
|
||||
1. 使用快捷键 `Ctrl + Shift + P` (Windows/Linux) 或 `Cmd + Shift + P` (macOS)
|
||||
2. 输入命令 `workbench.mcp.openUserMcpJson` 并执行
|
||||
3. 在打开的 `mcp.json` 配置文件中添加以下内容：
|
||||
|
||||
```json
|
||||
{
|
||||
"servers": {
|
||||
"devstar": {
|
||||
"type": "http",
|
||||
"url": "http://<YOUR_DEVSTAR_HOST>/api/mcp",
|
||||
"headers": {
|
||||
"Authorization": "Bearer <YOUR_TOKEN>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Trae IDE（容器环境）**
|
||||
|
||||
Trae IDE 运行在容器内部，其 MCP 配置文件位于：
|
||||
- **容器内路径**: `/root/.trae-server/data/Machine/mcp.json`
|
||||
|
||||
由于 Trae IDE 运行在容器内，需要通过 SSH 访问容器来修改配置文件。建议使用 **DevStar VS Code 插件**自动配置，插件会自动处理容器内的配置。
|
||||
|
||||
如果需要手动配置，SSH 进入容器后，编辑配置文件：
|
||||
|
||||
```bash
|
||||
# SSH 进入容器
|
||||
ssh root@<container-ip>
|
||||
|
||||
# 编辑 MCP 配置文件
|
||||
vi /root/.trae-server/data/Machine/mcp.json
|
||||
```
|
||||
|
||||
添加以下内容：
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"devstar": {
|
||||
"type": "http",
|
||||
"url": "http://<YOUR_DEVSTAR_HOST>/api/mcp",
|
||||
"headers": {
|
||||
"Authorization": "Bearer <YOUR_TOKEN>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> **注意**：
|
||||
> - 将 `<YOUR_TOKEN>` 替换为你的访问令牌
|
||||
> - 将 `https://devstar.cn` 替换为你的 DevStar 实例地址
|
||||
> - Windows 和 Linux 平台的具体配置路径可能因 IDE 版本而异，请参考对应 IDE 的官方文档
|
||||
> - 配置完成后需要重启 IDE 以使更改生效
|
||||
|
||||
## API 端点
|
||||
|
||||
DevStar MCP Server 通过以下端点提供服务：
|
||||
|
||||
| 端点 | 方法 | 描述 |
|
||||
|------|------|------|
|
||||
| `/api/mcp` | POST | MCP JSON-RPC 请求入口 |
|
||||
|
||||
### 认证方式
|
||||
|
||||
支持两种认证方式：
|
||||
|
||||
**方式 1：Authorization Header（推荐）**
|
||||
```
|
||||
Authorization: Bearer <your_token>
|
||||
```
|
||||
|
||||
**方式 2：URL 参数**
|
||||
```
|
||||
/api/mcp?token=<your_token>
|
||||
```
|
||||
|
||||
## 可用工具
|
||||
|
||||
DevStar MCP Server 提供了以下 10 大类工具，共 89 个具体功能：
|
||||
|
||||
### 1. Actions 工具 (27个)
|
||||
|
||||
**仓库 Actions：**
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `list_repo_action_runs` | 列出仓库 Actions 运行记录 |
|
||||
| `get_repo_action_run` | 获取单个 Action 运行详情 |
|
||||
| `rerun_repo_action_run` | 重新运行失败的 Action |
|
||||
| `cancel_repo_action_run` | 取消正在运行的 Action |
|
||||
| `list_repo_action_run_jobs` | 列出 Action 运行的作业 |
|
||||
| `get_repo_action_job_log_preview` | 获取 Action 日志预览 |
|
||||
| `download_repo_action_job_log` | 下载 Action 日志到文件 |
|
||||
| `list_repo_action_workflows` | 列出仓库 Actions 工作流 |
|
||||
| `get_repo_action_workflow` | 获取单个工作流详情 |
|
||||
| `dispatch_repo_action_workflow` | 触发 Actions 工作流 |
|
||||
| `list_repo_action_jobs` | 列出 Actions 作业 |
|
||||
| `list_repo_action_secrets` | 列出仓库 Actions 密钥 |
|
||||
| `list_repo_action_variables` | 列出仓库 Actions 变量 |
|
||||
| `get_repo_action_variable` | 获取仓库 Actions 变量 |
|
||||
| `create_repo_action_variable` | 创建仓库 Actions 变量 |
|
||||
| `update_repo_action_variable` | 更新仓库 Actions 变量 |
|
||||
| `delete_repo_action_variable` | 删除仓库 Actions 变量 |
|
||||
| `upsert_repo_action_secret` | 创建或更新仓库 Actions 密钥 |
|
||||
| `delete_repo_action_secret` | 删除仓库 Actions 密钥 |
|
||||
|
||||
**组织 Actions：**
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `list_org_action_secrets` | 列出组织 Actions 密钥 |
|
||||
| `list_org_action_variables` | 列出组织 Actions 变量 |
|
||||
| `get_org_action_variable` | 获取组织 Actions 变量 |
|
||||
| `create_org_action_variable` | 创建组织 Actions 变量 |
|
||||
| `update_org_action_variable` | 更新组织 Actions 变量 |
|
||||
| `delete_org_action_variable` | 删除组织 Actions 变量 |
|
||||
| `upsert_org_action_secret` | 创建或更新组织 Actions 密钥 |
|
||||
| `delete_org_action_secret` | 删除组织 Actions 密钥 |
|
||||
|
||||
### 2. 仓库/分支/标签工具 (16个)
|
||||
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `create_branch` | 创建新分支 |
|
||||
| `delete_branch` | 删除分支 |
|
||||
| `list_branches` | 列出所有分支 |
|
||||
| `create_tag` | 创建标签 |
|
||||
| `delete_tag` | 删除标签 |
|
||||
| `get_tag` | 获取标签详情 |
|
||||
| `list_tags` | 列出所有标签 |
|
||||
| `list_repo_commits` | 列出仓库提交记录 |
|
||||
| `create_file` | 创建文件 |
|
||||
| `update_file` | 更新文件 |
|
||||
| `delete_file` | 删除文件 |
|
||||
| `get_file_content` | 获取文件内容和元数据 |
|
||||
| `get_dir_content` | 获取目录内容列表 |
|
||||
| `list_my_repos` | 列出我的仓库 |
|
||||
| `create_repo` | 创建仓库 |
|
||||
| `fork_repo` | Fork 仓库 |
|
||||
|
||||
### 3. Issue 工具 (11个)
|
||||
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `get_issue_by_index` | 根据索引获取 Issue |
|
||||
| `list_repo_issues` | 列出仓库 Issues |
|
||||
| `create_issue` | 创建 Issue |
|
||||
| `edit_issue` | 编辑 Issue |
|
||||
| `create_issue_comment` | 创建 Issue 评论 |
|
||||
| `edit_issue_comment` | 编辑 Issue 评论 |
|
||||
| `get_issue_comments_by_index` | 获取 Issue 评论 |
|
||||
| `add_issue_labels` | 添加 Issue 标签 |
|
||||
| `remove_issue_label` | 移除单个 Issue 标签 |
|
||||
| `replace_issue_labels` | 替换 Issue 标签 |
|
||||
| `clear_issue_labels` | 清除 Issue 标签 |
|
||||
|
||||
### 4. Pull Request 工具 (4个)
|
||||
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `get_pull_request_by_index` | 根据索引获取 Pull Request |
|
||||
| `list_repo_pull_requests` | 列出 Pull Requests |
|
||||
| `create_pull_request` | 创建 Pull Request |
|
||||
| `create_pull_request_reviewer` | 添加 PR 审查者 |
|
||||
|
||||
### 5. 标签工具 (9个)
|
||||
|
||||
**仓库标签：**
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `list_repo_labels` | 列出仓库标签 |
|
||||
| `get_repo_label` | 获取单个标签 |
|
||||
| `create_repo_label` | 创建仓库标签 |
|
||||
| `edit_repo_label` | 编辑仓库标签 |
|
||||
| `delete_repo_label` | 删除仓库标签 |
|
||||
|
||||
**组织标签：**
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `list_org_labels` | 列出组织标签 |
|
||||
| `create_org_label` | 创建组织标签 |
|
||||
| `edit_org_label` | 编辑组织标签 |
|
||||
| `delete_org_label` | 删除组织标签 |
|
||||
|
||||
### 6. 里程碑工具 (5个)
|
||||
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `get_milestone` | 获取里程碑详情 |
|
||||
| `list_milestones` | 列出所有里程碑 |
|
||||
| `create_milestone` | 创建里程碑 |
|
||||
| `edit_milestone` | 编辑里程碑 |
|
||||
| `delete_milestone` | 删除里程碑 |
|
||||
|
||||
### 7. Wiki 工具 (6个)
|
||||
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `list_wiki_pages` | 列出所有 Wiki 页面 |
|
||||
| `get_wiki_page` | 获取 Wiki 页面内容 |
|
||||
| `get_wiki_revisions` | 获取 Wiki 页面修订历史 |
|
||||
| `create_wiki_page` | 创建 Wiki 页面 |
|
||||
| `update_wiki_page` | 更新 Wiki 页面 |
|
||||
| `delete_wiki_page` | 删除 Wiki 页面 |
|
||||
|
||||
### 8. Release 工具 (5个)
|
||||
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `list_releases` | 列出发布版本 |
|
||||
| `get_release` | 获取发布版本详情 |
|
||||
| `get_latest_release` | 获取最新发布版本 |
|
||||
| `create_release` | 创建发布版本 |
|
||||
| `delete_release` | 删除发布版本 |
|
||||
|
||||
### 9. 用户与搜索工具 (5个)
|
||||
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `get_my_user_info` | 获取当前用户信息 |
|
||||
| `get_user_orgs` | 获取用户所属组织 |
|
||||
| `search_users` | 搜索用户 |
|
||||
| `search_repos` | 搜索仓库 |
|
||||
| `search_org_teams` | 搜索组织团队 |
|
||||
|
||||
### 10. 版本工具 (1个)
|
||||
|
||||
| 工具名称 | 描述 |
|
||||
|---------|------|
|
||||
| `get_gitea_mcp_server_version` | 获取 MCP Server 版本 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
### 示例 1：创建分支
|
||||
|
||||
在 Claude Code 中：
|
||||
|
||||
```
|
||||
请在仓库 devstar/demo 的 main 分支基础上创建一个新分支 feature/new-function
|
||||
```
|
||||
|
||||
### 示例 2：创建 Issue
|
||||
|
||||
在 Cursor 中：
|
||||
|
||||
```
|
||||
帮我创建一个 Issue：
|
||||
- 仓库：devstar/docs
|
||||
- 标题：更新 MCP Server 文档
|
||||
- 描述：添加 DevStar 内置 MCP Server 的使用说明
|
||||
```
|
||||
|
||||
### 示例 3：查看 PR 状态
|
||||
|
||||
在 VS Code Copilot 中：
|
||||
|
||||
```
|
||||
显示 devstar/devstar 仓库 #54 号 PR 的详细信息
|
||||
```
|
||||
|
||||
## 独立部署Gitea MCP Server（Docker）
|
||||
|
||||
DevStar 平台兼容 Gitea 官方的 Docker 方式独立部署Gitea MCP Server。如果你想使用Gitea MCP Server，请参考 [Gitea MCP Server 官方文档](https://docs.gitea.com/usage/mcp-server) 获取详细的部署和配置说明。
|
||||
|
||||
## 支持的客户端
|
||||
|
||||
DevStar MCP Server 支持所有遵循 MCP 协议的 AI 编程助手。以下是一些常用的客户端：
|
||||
|
||||
### Claude Code
|
||||
|
||||
- 配置文件：`~/.claude/mcp_servers.json` (macOS/Linux) 或 `%APPDATA%\Claude\mcp_servers.json` (Windows)
|
||||
- 原生支持 HTTP 传输模式
|
||||
- [官方文档](https://docs.anthropic.com/claude-code/mcp)
|
||||
|
||||
### VS Code Copilot
|
||||
|
||||
VS Code Copilot 运行在**本地机器**上（容器外），因此配置文件位于本地文件系统：
|
||||
- **配置文件路径**：
|
||||
- macOS: `~/Library/Application Support/Code/User/mcp.json`
|
||||
- Windows: `%APPDATA%/Code/User/mcp.json`
|
||||
- **配置格式**：使用 `servers` 字段
|
||||
- **配置方式**：使用 `Ctrl+Shift+P` 输入 `workbench.mcp.openUserMcpJson` 命令打开配置文件
|
||||
- [官方文档](https://vscode.js.cn/docs/copilot/customization/mcp-servers)
|
||||
|
||||
### Cursor
|
||||
|
||||
<!-- TODO: 添加 Cursor 的详细说明 -->
|
||||
|
||||
#### Cursor
|
||||
|
||||
- 配置放在 `.cursor/mcp.json` 或 `.vscode/mcp.json`。
|
||||
- 打开 Cursor → 会提示“检测到 MCP Server”。点 Enable 即可。
|
||||
- 配置文件：`.cursor/mcp.json` 或 `.vscode/mcp.json`
|
||||
- [官方文档](https://cursor.com/cn/docs/context/mcp)
|
||||
|
||||
### Trae IDE
|
||||
|
||||
Trae IDE 运行在**容器内部**，因此配置文件位于容器内：
|
||||
- **容器内配置路径**：`/root/.trae-server/data/Machine/mcp.json`
|
||||
- **配置格式**：使用 `mcpServers` 字段
|
||||
- **配置方式**：需要 SSH 进入容器后手动配置，或使用 DevStar VS Code 插件自动配置
|
||||
- **注意**：由于运行在容器内，与 VS Code Copilot（本地运行）使用不同的配置路径
|
||||
|
||||
#### Continue
|
||||
### Windsurf
|
||||
|
||||
- 配置放在 `.continue/mcpServers/mcp.json`
|
||||
- [官方文档](https://docs.continue.dev/customize/deep-dives/mcp)
|
||||
<!-- TODO: 添加 Windsurf 的详细说明 -->
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 常见问题
|
||||
|
||||
**Q: DevStar VS Code 插件无法自动配置 MCP**
|
||||
```
|
||||
A: 检查以下项：
|
||||
- 确认已正确登录 DevStar 账号
|
||||
- 检查配置文件是否有写入权限
|
||||
- 查看插件日志（输出面板）
|
||||
- 尝试手动配置（见上方"手动配置"部分）
|
||||
```
|
||||
|
||||
**Q: MCP Server 连接失败**
|
||||
```
|
||||
A: 检查以下项：
|
||||
- DevStar 实例地址是否正确
|
||||
- 访问令牌是否有效且未过期
|
||||
- 网络连接是否正常
|
||||
- 防火墙是否允许访问
|
||||
- IDE 是否已重启以加载配置
|
||||
```
|
||||
|
||||
**Q: AI 助手无法访问 DevStar 功能**
|
||||
```
|
||||
A: 确认：
|
||||
- MCP Server 配置文件路径正确
|
||||
- Bearer Token 格式正确（以 "Bearer " 开头）
|
||||
- 访问令牌具有足够的权限
|
||||
- IDE 已重启以加载新配置
|
||||
```
|
||||
|
||||
**Q: Token 过期或失效**
|
||||
```
|
||||
A: 访问令牌有过期时间。如果过期，需要：
|
||||
1. 重新生成令牌
|
||||
2. 更新 MCP 客户端配置
|
||||
3. 重启 IDE
|
||||
```
|
||||
|
||||
**Q: 配置文件路径在哪里？**
|
||||
```
|
||||
A: 配置文件路径取决于你使用的 IDE：
|
||||
- Claude Code: ~/.claude/mcp_servers.json (macOS/Linux) 或 %APPDATA%\Claude\mcp_servers.json (Windows)
|
||||
- Cursor: ~/.cursor/mcp.json (macOS/Linux) 或 %USERPROFILE%\.cursor\mcp.json (Windows)
|
||||
- VS Code Copilot: ~/Library/Application Support/Code/User/mcp.json (macOS) 或 %APPDATA%/Code/User/mcp.json (Windows)
|
||||
- Trae IDE（容器内）: /root/.trae-server/data/Machine/mcp.json
|
||||
- Windsurf: <!-- TODO: 添加 Windsurf 配置路径 -->
|
||||
|
||||
注：具体路径可能因 IDE 版本而异，请参考对应 IDE 的官方文档
|
||||
```
|
||||
|
||||
**Q: 工具调用失败**
|
||||
```
|
||||
A: 确认：
|
||||
- 访问令牌具有足够的权限
|
||||
- 仓库名称和所有者名称正确
|
||||
- 用户有相应操作的权限
|
||||
```
|
||||
|
||||
## 技术实现
|
||||
|
||||
DevStar MCP Server 基于 [mcp-go](https://github.com/mark3labs/mcp-go) 库实现，采用以下技术栈：
|
||||
|
||||
- **协议版本**: MCP 2024-11-05
|
||||
- **传输方式**: HTTP POST
|
||||
- **认证方式**: Bearer Token
|
||||
- **数据格式**: JSON-RPC 2.0
|
||||
|
||||
### 核心组件
|
||||
|
||||
```
|
||||
services/mcp/
|
||||
├── config.go # MCP 配置
|
||||
├── context/ # Token 上下文管理
|
||||
├── gitea/ # Gitea SDK 客户端
|
||||
├── operation/ # MCP 工具实现
|
||||
│ ├── actions/ # CI/CD Actions 工具
|
||||
│ ├── issue/ # Issue 工具
|
||||
│ ├── pull/ # Pull Request 工具
|
||||
│ ├── repo/ # 仓库工具
|
||||
│ └── ...
|
||||
└── log/ # 日志模块
|
||||
|
||||
routers/api/mcp/
|
||||
├── mcp.go # 请求处理入口
|
||||
└── server/ # MCP Server 实现
|
||||
```
|
||||
|
||||
## 更多资源
|
||||
|
||||
- [MCP 协议规范](https://modelcontextprotocol.io)
|
||||
- [DevStar 平台文档](https://devstar.cn/devstar/docs)
|
||||
- [Claude Code 文档](https://docs.anthropic.com/claude-code)
|
||||
- [Cursor MCP 文档](https://cursor.com/cn/docs/context/mcp)
|
||||
- [VS Code Copilot MCP 文档](https://vscode.js.cn/docs/copilot/customization/mcp-servers)
|
||||
BIN
src/devstar/static/exp.png
Normal file
BIN
src/devstar/static/exp.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 68 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 240 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 326 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 214 KiB |
Reference in New Issue
Block a user