【免费下载链接】superplaneOpen source factory for one-shot engineering项目地址https://gitcode.com/gh_mirrors/su/superplane点击查看免费下载导读本文介绍 SuperPlane 仓库中.cursor/commands/changelog.md命令与配套技能superplane-changelog的完整用法给定一个时间范围如 since Monday、last 5 days 或 since v0.6.0自动梳理合并到main分支的提交将其分类为新的集成integrations、新的组件与触发器components/triggers、用户可见改进improvements、安全更新security和缺陷修复bug fixes并输出一份格式统一、以用户视角撰写、写入tmp/目录的 Markdown 更新日志。读完本文你将掌握从 git 历史中提取发布摘要的完整工作流、严格的分类与格式规则以及如何在仓库源码中解析集成与组件名称从而为 SuperPlane 的每次迭代产出可直接发布的 Whats New 文档。1. changelog 命令是什么.cursor/commands/changelog.md是 SuperPlane 仓库内定义的一个 Cursor 命令command其 frontmatter 中的描述为Generate a whats new changelog from merged commits over a time range (e.g. since Monday, last 5 days). Writes user-focused markdown totmp/.命令的核心目标不是复述 git 提交记录而是产出一份面向用户user-focused的更新日志涵盖新增集成、新增组件与触发器、改进、安全更新和缺陷修复五类内容最终写入tmp/目录下的单个 Markdown 文件。命令正文明确要求调用.cursor/skills/superplane-changelog/SKILL.md中定义的完整工作流包括时间范围计算、提交分类、格式规则禁用破折号 em dash、禁用 We 人称、**集成名:** 组件名的条目格式、CVE 安全专节等以及输出结构。命令还要求章节标题必须携带数字计数例如#### 3 new integrations与#### 12 new components and triggers。仓库内的其他相关文件命令定义.cursor/commands/changelog.md技能定义.cursor/skills/superplane-changelog/SKILL.md仓库根目录的 cliff.toml 提供了基于 git-cliff 的自动化 changelog 生成配置可作为命令产出的人工精修版与自动生成版的对照参考。1.1 命令与技能的协作关系命令文件本身是入口约定了输入、流程与输出技能文件则是规则全集包含六个部分时间范围确定、分类规则、严格格式规则、输出结构模板、工作流摘要与参考示例。二者协作的分工是命令定义输入参数时间范围与顶层流程1 确定窗口、2 运行git log、3 分类、4 解析名称、5 写文件技能提供每一步的细节规则、可执行命令片段、输出模板与反例说明如chore:提交严禁作为任何条目的来源。2. 输入与前置准备2.1 输入时间范围唯一必填参数命令只有一个必填输入Time range支持的自然语言表达包括表达方式示例窗口语义星期起始since Monday本周一零点至今天数last 5 days周一至周五星期起始since last Friday上周五至今日期区间from Feb 3 to now2 月 3 日零点至今版本标签since v0.6.0标签提交时间之后至今若用户未指定默认采用since Monday (5 days)即本周一零点起 5 天窗口。注意技能文档强调当起始点是版本标签时必须使用日期和时间而非仅日期以确保标签同一天内早于标签的提交被排除。2.2 前置仓库内解析名称的源码依据技能要求从pkg/integrations/与pkg/components/解析组件/触发器名称及其所属集成通过各集成与组件的Label()/Name()方法。当前仓库中pkg/integrations/下包含约 50 个集成目录例如aws/、azure/、github/、gitlab/、jira/、linear/、slack/、sendgrid/、sentry/、smtp/、telegram/、openai/、openrouter/等pkg/components/下包含通用组件目录例如addmemory/、approval/、http/、if/、loop/、foreach/、merge/、filter/、graphql/、ssh/、wait/、timegate/、messages/、runner/、runs/等技能文档特别举例SSH 属于pkg/components/ssh是独立组件而非集成不应被计入新集成。3. 第一步确定时间范围并运行 git log3.1 计算窗口起点技能文档给出的计算规则分两类仅日期范围如since Monday、Feb 3 to now起点取该日零点YYYY-MM-DD终点为今天版本标签范围如since v0.6.0起点取标签的确切提交时间戳通过 ISO 8601 格式命令取得git log -1 --format%cI v0.6.0该命令输出例如2026-02-01T15:30:0000:00。以这个时间戳作为--since起点可以保证版本标签同一天内早于标签的提交不被错误计入。3.2 拉取窗口内提交使用git log配合--since与格式化占位符git log --sincestart --format%h %ad %s main其中start有两种形态仅日期范围传YYYY-MM-DD如2026-02-03配合--dateshort版本标签范围传标签的 ISO 8601 时间戳如2026-02-01T15:30:0000:00需要比较时间时配合--dateiso。返回结果形如%h短提交哈希、%ad作者日期、%s提交主题据此识别窗口内落地到main的内容。技能文档同时提示必要时可针对关键 PR 额外查看合并日期。3.3 与 cliff.toml 自动生成的差异仓库根目录的 cliff.toml 使用 git-cliff 按 Conventional Commits 前缀自动分组feat→ New features、fix→ Bug Fixes、其余 → Improvements并提供CUSTOM SUMMARY PLACEHOLDER供人工编写精修摘要。对比可见git-cliff 自动生成按提交前缀机械分组chore:也会被归入 Improvementssuperplane-changelog 技能强制剔除chore:提交、要求以用户视角改写、安全与缺陷修复单独成节且携带计数。因此命令产出的 changelog 是比 git-cliff 默认输出更贴近发布文档的人工策展版。4. 第二步提交分类规则技能文档对每一类内容都给出了严格的判定标准这是整个 changelog 质量的核心。4.1 强制排除chore:提交技能文档明确任何条目的来源都不得是chore:或chore(...):前缀的提交。即便某个 chore 提交看起来影响用户如 Allow running multiple instances也必须省略。可用的提交来源前缀包括feat:、fix:、docs:仅限面向用户的文档改动等非 chore 前缀。4.2 新集成New integrations仅统计在窗口内完整新增的集成基础集成注册 首批组件例如 SendGrid、Jira独立组件不计入此节例如 SSH 是pkg/components/ssh下的组件不是集成列出格式每行一个集成名。4.3 新组件与触发器New components and triggers仅统计首次出现在时间窗口内的组件/触发器若集成早已存在只列出新增的组件如 GitHub: Get Release若集成本身是新的则列出其全部组件与触发器使用提交时间戳日期和时间排除窗口起点之前的内容例如since v0.6.0窗口需排除时间戳早于或等于标签提交时间的提交列出格式**集成名:** 组件1, 组件2, 触发器1每行一个集成独立组件单独成行。4.4 改进Improvements只收录来自非 chore 提交的用户可见产品变更如 RBAC、Secrets、集成 UX排除内部/技术性条目如 Component/Trigger Cleanup()、Cursor skills每条必须以用户视角描述用户能做什么、解决了什么问题、获得什么收益。例如 Define roles and permissions and control what each user can do 优于 Permission guard in the UI。4.5 安全更新Security在窗口内存在安全相关提交时必须设置独立的Security专节关键词线索security、SSRF、CVE、vulnerability、auth、injection、XSS、sanitiz等若安全修复仅影响本窗口内新引入的组件/集成则不计入条目格式有 CVE 时写CVE-YYYY-NNNNN: 漏洞与修复简述无 CVE 时写Fixed: 描述如 Fixed: SSRF protection added to HTTP requests。4.6 缺陷修复Bug Fixes收录窗口内的修复与可靠性改进安全修复除外归入 Security即使偏技术性也保留在 Bug Fixes若修复仅影响本窗口内新引入的组件/集成则不计入如 AWS ECR 与 ECR 同时新增时fix: AWS ECR timestamp 应省略条目格式每条以Fixed:开头。5. 第三步从源码解析集成与组件名称技能文档规定解析组件/触发器名称及其归属集成时检查pkg/integrations/*/与pkg/components/*/读取各集成的Components()和Triggers()以及组件/触发器的Label()/Name()。以 GitHub 集成为例pkg/integrations/github/github.go 中的init()通过registry.RegisterIntegrationWithOptions(github, GitHub{}, ...)注册集成见 github.go 第 66-71 行其组件拆分在pkg/integrations/github/components/下包括actions/、admin/、checks/、contents/、dependabot/、deployments/、issues/、metadata/、pulls/、statuses/等子目录对应的就是 changelog 中**GitHub:** Get Release这类条目名称的解析来源。独立组件的解析路径类似例如pkg/components/ssh/目录下包含ssh.go组件定义与 Label、client.goSSH 客户端实现、example.go与example_output.json示例输入输出、ssh_test.go测试。当技能文档给出**SSH:** Run commands on remote hosts的示例条目时其名称即来自ssh.go中的 Label/Name 定义。6. 第四步严格格式规则技能文档列出的格式规则是硬性要求直接决定了产出文档的可读性与一致性禁用 em dash—用冒号或括号替代例如**RBAC**: 描述禁用 We 人称使用直接、中性的表达如 Role-based access control. 而非 We introduced role-based access control.新集成节仅列集成名每行一个新组件节使用**Integration:** Component1, Component2, ...每个集成或独立组件占一行如**GitHub:** Get Release、**SSH:** Run commands on remote hosts改进条目每条为**粗体标签**: 简短的用户导向描述从用户视角写出能力、解决的问题或收益避免实现术语如 permission guard、payload limit优先结果与能力如 Control what each user can do in your organization、Secrets can be used in the SSH component to store private keys不使用 We安全条目仅在存在安全提交时设置专节有 CVE 时携带 CVE 标识符无 CVE 时使用Fixed:前缀缺陷修复条目每条以Fixed:开头安全修复归入 Security 而非此处省略仅适用于本窗口新增组件/集成的修复。7. 输出结构与完整模板技能文档要求把结果写入tmp/changelog_YYYY-MM-DD_to_YYYY-MM-DD.md或类似命名并给出以下标准结构。章节标题必须包含数字计数集成按集成计 1 个组件与触发器每个计 1 个例如一行**GitHub:** Get Release, On Release计为 2计数必须与列出条目及所选窗口严格一致。# SuperPlane Changelog (Feb X-Y, YYYY) ## Whats new since [Monday], [Month Day], YYYY (X days) #### N new integrations - IntegrationA - IntegrationB #### M new components and triggers - **IntegrationA:** Component1, Component2, Trigger1 - **IntegrationB:** Component1 - **Standalone:** Description (e.g. **SSH:** Run commands on remote hosts) #### Improvements - **RBAC**: Role-based access control. Define roles and permissions... - **Secrets**: Create, update, and delete organization secrets... - (etc.) #### Security - CVE-YYYY-NNNNN: Short description of vulnerability and fix (when CVE exists). - Fixed: Short description of security fix (when no CVE). (Omit this section entirely if no security-related commits in the window.) #### Bug Fixes - Fixed: Short description - Fixed: ...格式细节每个####标题下的列表项使用三个空格缩进N为列出的集成数量M为组件与触发器总数量即使多个组件在同一行每个也各计 1若窗口内没有安全相关提交整个 Security 节必须省略。8. 完整工作流端到端执行步骤技能文档将整个流程归纳为 6 步与命令文件中的 5 步流程相互印证合并后为确定时间范围询问或推断窗口Monday to now 即 5 天since v0.6.0 即标签提交时间戳之后。未指定时默认 since Monday (5 days)拉取提交运行git log --sincestart --format%h %ad %s mainstart为YYYY-MM-DD或版本标签的 ISO 8601 时间戳按需使用--dateshort或--dateiso必要时检查关键 PR 的合并日期分类识别新集成仅完整新增、新组件/触发器按集成、仅窗口内、改进仅用户可见、绝不来自 chore 提交、安全修复专节、与缺陷修复分离、缺陷修复任何节都不得包含或衍生自chore:/chore(...):提交解析名称从pkg/integrations/name/与pkg/components/读取Label()/Name()解析组件/触发器名称及其归属集成写文件按上述结构与格式规则写入tmp/changelog_range.md交付告知用户生成文件的路径并邀请用户审阅、按需编辑。命令文件的 Output 部分对第 6 步做了补充输出内容包含生成文件的路径例如tmp/changelog_2026-02-03_to_2026-02-06.md并邀请用户 review 和编辑。9. 实战示例与落地建议9.1 一次典型会话的产物形态假设用户输入 since Monday本周一零点起 5 天窗口执行完整流程后tmp/下会生成类似tmp/changelog_2026-02-03_to_2026-02-06.md的文件其内容遵循第 7 节模板# SuperPlane Changelog (Feb 3-6, 2026) ## Whats new since Monday, Feb 3, 2026 (5 days) #### 2 new integrations - SendGrid - Jira #### 4 new components and triggers - **GitHub:** Get Release, On Release - **SendGrid:** Send Email - **SSH:** Run commands on remote hosts #### Improvements - **RBAC**: Role-based access control. Define roles and permissions and control what each user can do in your organization. - **Secrets**: Create, update, and delete organization secrets; secrets can be used in the SSH component to store private keys. #### Security - CVE-2024-12345: Fixed an SSRF issue in outbound HTTP requests. #### Bug Fixes - Fixed: GitHub webhook events occasionally arriving out of order. - Fixed: Slack message previews truncating long text.注意上例中#### 4 new components and triggers的计数方式**GitHub:** Get Release, On Release一行计 2加**SendGrid:** Send Email1与**SSH:** ...1合计 4与标题计数一致。9.2 使用前提与注意事项该工作流要求仓库是带有完整 git 历史的本地克隆含main分支与版本标签且需要具备在tmp/目录写文件的权限命令运行于 Cursor 环境命令与技能均位于.cursor/目录下也可在普通终端中按同样步骤手动执行版本标签窗口since v0.6.0对仓库的标签命名有依赖仓库根目录 cliff.toml 中tag_pattern v[0-9]*即是对此类版本标签的约定计数、类别与格式三者必须自洽技能文档反复强调计数必须匹配所列条目任何由chore:提交衍生出的条目都属于违规输出。10. 小结.cursor/commands/changelog.md与其技能superplane-changelog共同构成了一套可复用的发布摘要生成方案以时间窗口为输入以git log为数据源以用户视角为撰写准则以严格的分类、计数与格式规则保证产出质量。结合仓库内pkg/integrations/与pkg/components/的真实目录与 Label 定义这份工作流不仅适用于 SuperPlane 自身其分类-解析-格式化-写文件的范式也可以迁移到任何以 git 为核心协作方式的 Go 项目发布流程中。对于希望进一步自动化产出 changelog 的团队仓库根目录的 cliff.toml 提供了 git-cliff 的补充方案可与本文介绍的人工策展流程配合使用。赞分享【免费下载链接】superplaneOpen source factory for one-shot engineering项目地址https://gitcode.com/gh_mirrors/su/superplane点击查看免费下载相关推荐ChangelogChangelog 1.6.3.0 2023 10 20 ✨ 新功能 Add Windows 11 compatibility support 891c93c桌面应用Python类型安全革命MyPy如何将动态语言转化为类型安全的工程利器Python类型安全革命MyPy如何将动态语言转化为类型安全的工程利器 价值主张开篇 在Python的动态类型世界中MyPy扮演着革命性的角色——它将静态类开发工具静态分析代码质量Documenso 本地开发与自托管部署指南从 npm 快速启动到 Docker Compose 生产配置Documenso 本地开发与自托管部署指南从 npm 快速启动到 Docker Compose 生产配置 本文基于 Documenso 仓库根目录的 REA上一篇MyIP集成IP2Location教程提升地理位置检测精度下一篇Vue3DraggableResizable进阶技巧10个实用Props让组件更强大创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考