mcpField
C
cms-branches-aliases

cms-branches-aliases

github.com/contentstack云与 DevOps589 次安装1 周前更新
代码仓库

关于 cms-branches-aliases

面向 Contentstack 开发者的只读指导 Skill，帮助规划分支内容开发与别名部署，涵盖隔离变更、CI/CD、安全发布和回滚，不会操作分支或别名。

主要功能

  1. 01分支策略建议
  2. 02分支专属与全局模块说明
  3. 03基于别名的部署模式
  4. 04CI/CD 与暂存环境指导
  5. 05合并与回滚建议

适用场景

  1. 01规划短期功能分支
  2. 02使用别名发布内容变更
  3. 03设计暂存到生产的发布流程
  4. 04评估部署异常后的恢复方案

安装

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

$npx skills add https://github.com/contentstack/contentstack-agent-skills --skill cms-branches-aliases

安装后在 Claude Code 中输入/cms-branches-aliases确认已加载。

详细介绍

分支与别名

说明

指导开发者使用 Contentstack 分支进行隔离的内容开发，并使用别名实现零停机内容部署。涵盖分支策略、分支专属模块与全局模块、CI/CD 集成、合并行为和回滚模式。

适用场景

开发者询问分支、别名、与 Contentstack 的 CI/CD 集成、部署策略，或分支专属模块与全局模块行为时使用。

用户问题

开发者需要安全地修改架构和内容，而不影响线上站点，然后以零停机方式部署更改，并能轻松回滚。

成功标准

推荐合适的分支策略。 准确说明分支专属模块与全局模块的区别。 提供实用的基于别名的部署模式。 提供安全的 CI/CD 集成指导。 清晰说明合并和回滚。

预期输入

  • 开发工作流或 CI/CD 流水线
  • 部署策略要求
  • 团队结构和协作需求
  • 回滚要求

预期输出

  • 分支策略建议
  • 全局模块与分支专属模块说明
  • 基于别名的部署模式
  • CI/CD 集成指导
  • 合并和回滚建议

用户请求示例

  • 如何使用分支进行内容架构开发？
  • 分支专属模块与全局模块有什么区别？
  • 如何零停机部署内容更改？
  • 分支如何与我的 CI/CD 流水线配合使用？
  • 可以回滚有问题的部署吗？

工作流摘要

了解开发和部署工作流。 推荐分支策略。 说明分支专属模块与全局模块的区别。 指导基于别名的部署。 介绍合并、回滚和 CI/CD 集成。

指令

[{"heading":"分支基础","content":"分支会将源分支的内容类型、全局字段、条目和资源复制到隔离的工作区。每个堆栈最多 5 个分支。在整个组织范围内，同一时间只能创建或删除一个分支。只有所有者、管理员和开发者可以管理分支。"},{"heading":"分支专属模块与全局模块","content":"分支专属：内容类型、全局字段、条目、资源、发布队列、发布、语言、扩展、审计日志、标签、搜索。全局：环境、webhook、工作流、发布规则、用户、角色、令牌。在 main 上创建的 webhook 在所有位置都可见，但可限定到特定分支。开发分支上的内容类型在合并前不会存在于 main 上。"},{"heading":"基于别名的部署","content":"别名指向分支。在前端代码中使用 deploy 之类的别名，而不要硬编码分支 UID。要将生产环境切换到新分支，请重新分配别名。无需更改前端代码。要回滚，请将别名重新分配回原分支。两个别名可以指向同一分支，但分支和别名不能使用相同的 UID。"},{"heading":"CI/CD 模式","content":"从 main 创建分支，进行架构和内容更改，在暂存环境中测试，将生产别名重新分配到新分支；如果出现问题，立即将别名重新分配回原分支。"},{"heading":"分支策略","content":"让分支的生命周期保持简短。长期存在的分支容易偏离并产生合并冲突。优先采用基于主干的工作流，将短期功能分支尽快合并回 main。不要将分支用作永久环境；应使用环境来实现这一目的。"},{"heading":"SDK 初始化","content":"显式传入分支或别名 ID，例如 branch: 'deploy'。如果未传递分支请求头，则默认使用 main。在脚本中始终显式传递分支请求头，即使目标是 main 也不例外。"}],

输出格式

提供简洁的分支和部署指导。优先提供实用的 CI/CD 模式，而不是抽象说明。

工具说明

仅提供只读建议。不要创建、删除或合并分支。

安全

默认设置
  • 切勿暴露令牌或 API 密钥。
  • 在示例代码中使用环境变量存储凭据。
  • 不要建议在客户端代码中硬编码密钥。
  • 确保指导内容兼容按分支和别名限定范围的凭据。
破坏性操作

不要创建、删除、合并或重新分配分支或别名。仅提供指导。

密钥

切勿暴露管理令牌、交付令牌、API 密钥或其他凭据。如需代码示例，仅使用环境变量和占位符名称。

环境变量

所有凭据和密钥值都使用环境变量。示例中切勿硬编码堆栈 API 密钥、令牌或分支限定范围的凭据。

产品上下文

    • 产品：CMS
    • 描述：Contentstack 无头 CMS：内容类型、条目、资源、环境、发布、工作流、Webhook 和 Content Management API（CMA）。
    • 产品安全规则：- 切勿暴露管理令牌或 API 密钥。
  • 始终使用环境变量存储凭据。
  • 在浏览器应用中，通过服务端代理路由所有 CMA 调用。
  • 切勿在客户端代码中硬编码堆栈 API 密钥。
    • 默认工具：["CMA API", "Content Types", "Entries", "Assets", "Workflows", "Webhooks", "Environments", "Releases", "Publish Queue"]
    • 默认连接器：["CMA Proxy", "Webhooks"]

评论

支持 Markdown