mcpField
A
atlas-best-practices

atlas-best-practices

github.com/alleneubank数据与数据库50211 次安装18 周前更新
代码仓库

关于 atlas-best-practices

Atlas Best Practices 是指导如何选择并安全执行 Atlas 数据库模式工作流的参考技能，涵盖声明式、版本化和基线方式，以及规划、验证和部署防护。

主要功能

  1. 01选择声明式、版本化或基线工作流
  2. 02应用模式变更前先制定计划
  3. 03对迁移进行 lint、测试和验证
  4. 04通过 CI/CD 或获批流程部署生产变更
  5. 05防范凭据泄露和破坏性变更

适用场景

  1. 01为项目选择模式管理工作流
  2. 02将现有数据库纳入管理
  3. 03部署前审查迁移
  4. 04避免不安全的生产模式变更

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/alleneubank/claude-code --skill atlas-best-practices

安装后在 Claude Code 中输入/atlas-best-practices确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
atlas-v1-1-features.md
cli-agent-gaps.md
core-workflows.md
safety-and-quality.md

详细介绍

Atlas 最佳实践

Atlas 支持声明式和版本化的架构工作流。请保持此文件精简，并且仅加载当前任务所需的参考文件。

工作流选择

  • 当目标架构状态是唯一事实来源时，使用声明式工作流。
  • 当审计和分阶段部署需要迁移文件时，使用版本化工作流。
  • 为现有数据库接入 Atlas 时，使用基线工作流。

默认执行流程

  1. 确认 atlas.hcl 中的目标 env。
  2. 确认已配置 dev，且与生产环境隔离。
  3. 先规划，再执行 lint、测试和验证，最后应用变更。
  4. 生产环境变更应通过 CI/CD 或经批准的部署工作流执行。

快速命令

# Declarative
atlas schema apply --env local

# Versioned
atlas migrate diff add_change --env local
atlas migrate lint --env local --latest 1
atlas migrate apply --env local

# Integrity
atlas migrate validate --env local
atlas migrate status --env local

参考文件索引

  • core-workflows.md 用于环境配置、架构即代码模式、声明式与版本化工作流、建立基线以及 ORM 提供程序加载。
  • safety-and-quality.md 用于 lint 分析器、事务模式、架构测试、执行前检查以及 CI 模式。
  • atlas-v1-1-features.md 用于了解 Atlas v1.1 的功能（于 2026-02-03 发布），包括安全即代码、声明式数据、新的驱动程序和平台支持、Slack 集成、架构导出器以及 MySQL TLS。
  • cli-agent-gaps.md 用于了解 Atlas CLI 的功能和 Agent 常忽略的边缘情况：规划工作流、迁移目录维护命令、URL/TLS 易错点、功能可用性以及版本策略限制。

防护措施

  • 请勿将凭据写入源文件；优先使用 Atlas 数据源和输入变量。
  • 对具有破坏性或依赖数据的迁移，必须进行明确审核。
  • 对不受支持的驱动程序、缺少 dev URL 或未知环境名称，应明确报错。

评论

支持 Markdown