SuperAPI AI 工具集

scaffold-project

部署与运维

查看项目

更新于 10-15 21:55

技能介绍

用途:为以代码方式管理 Grafana 资源创建新的 Go 项目骨架,命令为 gcx dev scaffold。

前置条件:先确认已安装 gcx,可运行 gcx --version;若未安装,参见 setup-gcx 技能。

使用方式:交互模式运行 gcx dev scaffold,会提示输入项目名(作为目录名,自动转为 kebab-case)和 Go 模块路径(如 github.com/myorg/my-dashboards)。非交互模式可运行 gcx dev scaffold --project my-dashboards --go-module-path github.com/myorg/my-dashboards。

生成内容:项目目录包含 .github/workflows/deploy.yaml(用于 gcx push 的 CI/CD 工作流)、.gitignore、go.mod、main.go(入口,注册所有资源)、internal/dashboards/all.go(返回所有清单的注册函数)、internal/dashboards/sample.go(使用 foundation-sdk 构建器的示例仪表盘)以及 README.md。

后续步骤:进入目录执行 go mod tidy;配置 gcx,包括 gcx config set stacks.default.grafana.server <URL>、gcx config set stacks.default.grafana.token <TOKEN> 和 gcx config set contexts.default.stack default;编辑 internal/dashboards/sample.go 或用 gcx dev generate 生成新桩;最后用 gcx resources push 推送到 Grafana。

常见问题:go mod tidy 失败时检查 Go 工具链是否满足生成的 go.mod 所需版本;项目名含空格会自动转为连字符;如需添加告警规则,可创建 internal/alerts/ 并使用 gcx dev generate alerts/my-rule.go。

限制:资料未提供其他平台支持、收费或价格信息。