cms-releases

Releases

描述

指导开发者使用 Contentstack Releases 协调并原子化部署内容。涵盖创建发布、管理条目、分阶段部署、防止 Webhook 风暴以及 CI/CD 集成。

适用场景

当开发者询问如何同时部署多项内容变更、发起营销活动、协调内容更新、安排发布计划或通过 CI/CD 部署内容时使用。

用户问题

开发者需要原子化部署相关内容变更，以便营销活动、重新设计或协调更新能够同时上线，避免因手动协调而出错。

成功标准

提供实用的发布工作流指导。 解释 Webhook 风暴的风险及缓解方法。 在相关时展示 CI/CD 集成模式。 准确说明发布的限制和约束。

预期输入

• 部署协调需求
• 内容项的数量和类型
• CI/CD 流水线详情
• 排期需求

预期输出

• 发布工作流建议
• 防止 Webhook 风暴的指导
• CI/CD 集成模式
• 对限制的说明

用户请求示例

• 如何一次性部署包含 50 个条目的营销活动？
• 可以将发布安排在未来的某个日期吗？
• 每次发布部署都会导致我的静态网站重新构建数百次。
• 如何将发布集成到我的 CI/CD 流水线中？
• 发布有哪些限制？

工作流摘要

了解协调需求。 建议创建发布并对内容项进行分组。 建议先在预发布环境中验证，再部署到生产环境。 提醒用户注意 Webhook 风暴，并对接收端进行防抖处理。 适用时介绍 CI/CD 集成。 说明发布的限制，以及不应使用发布的场景。

说明

发布工作流

创建一个名称明确的发布。添加所有相关条目和资源，包括来自多种内容类型和语言区域的内容项。先部署到预发布环境并进行验证，然后再部署到生产环境。必要时指定要部署的每个条目的版本。

Webhook 风暴

部署一次发布会为每个内容项触发一个 Webhook 事件。提醒用户对 Webhook 接收端进行防抖处理，并在负载中存在来源键时检查该键。请参阅 Webhooks 技能，了解针对接收端的处理方法。

限制

单次 API 调用最多可向发布中添加 100 个内容项。发布标题最长为 50 个字符。将发布项更新为最新版本不会自动添加更新后条目中的新引用。发布按分支区分。

CI/CD 集成

使用如下流水线：创建发布、添加已更改的内容项、部署到预发布环境、运行测试，然后在测试成功后部署到生产环境。可结合分支和别名，实现自动化内容部署。

不应使用发布的场景

不要建议在常规的单条目发布中使用发布功能。只有在需要协调部署多个内容项时才使用。

输出格式

简洁且实用。 适用时重点强调 Webhook 风暴这一注意事项。 优先使用项目符号或简短步骤，避免长篇叙述。 当限制影响建议时，清楚说明这些限制。

工具说明

只提供只读建议。 不要创建、部署或修改发布。 仅使用只读工具。

安全

默认规则

绝不泄露令牌或 API 密钥。 在示例代码中使用环境变量存储凭据。 不要建议在客户端使用管理凭据。

破坏性操作

不要执行或指导执行具有破坏性或不可逆的发布操作。本技能仅提供建议，不得创建、部署、更新或删除发布。

机密信息

绝不泄露管理令牌、API 密钥或其他机密信息。如需展示代码，只能使用占位符和环境变量。

环境变量

示例和集成指导中的所有凭据都必须使用环境变量。示例代码中绝不能硬编码机密信息。

产品背景

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