tenzir-ship

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

tenzir-ship

tenzir-ship

This skill bundles key release engineering use cases with tenzir-ship.
本Skill整合了tenzir-ship相关的核心发布工程用例。

Changelog history

变更日志历史

Treat released changelog data as published history. Files under
changelog/releases/
, including release notes, manifests, and release entry files, are immutable once published because they may already exist in GitHub releases, package registries, documentation, and downstream copies.
For normal follow-up work, add a new changelog entry on top of the existing history. Edit historical release artifacts only for severe publication defects, such as legally or operationally unsafe content, and only when the user explicitly asks for that correction.
已发布的变更日志数据视为已公开的历史记录。
changelog/releases/
下的文件,包括发布说明、清单和发布条目文件,一旦发布便不可修改,因为它们可能已存在于GitHub Releases、包注册表、文档和下游副本中。
对于常规后续工作,在现有历史记录顶部添加新的变更日志条目。仅当存在严重的发布缺陷(例如涉及法律或操作安全问题的内容),且用户明确要求修正时,才可编辑历史发布工件。

Available scripts

可用脚本

  • bash <skill-dir>/scripts/detect-change-scope.sh
    : Detects the current changelog scope. Use this before adding a changelog entry to identify whether staged, unstaged, or branch changes should drive the entry; the script prints a suggested diff command and the files in scope.
  • bash <skill-dir>/scripts/detect-change-scope.sh
    :检测当前变更日志的范围。在添加变更日志条目之前使用此脚本,以确定应根据暂存、未暂存还是分支变更来生成条目;脚本会输出建议的diff命令以及范围内的文件。

Use Cases

用例

Initialize a changelog project

初始化变更日志项目

Set up a new changelog workspace before the first entry exists. Prefer the explicit
init
command when the task is project setup rather than entry creation.
Instructions:
references/init-changelog-project.md
在首个条目创建前设置新的变更日志工作区。当任务是项目设置而非条目创建时,优先使用显式的
init
命令。
说明文档:
references/init-changelog-project.md

Add a changelog entry

添加变更日志条目

Add changelog entries as part of shipping bugfixes, changes, and features during day-to-day development.
Instructions:
references/add-changelog-entry.md
在日常开发中,修复bug、进行变更或开发功能时添加变更日志条目。
说明文档:
references/add-changelog-entry.md

Create a release

创建版本发布

We distinguish two types of releases:
  1. Remote: triggers a CI workflow
  2. Local: releases from a local repository
Prefer a remote release if a workflow exists, and use a local release otherwise.
我们区分两种类型的版本发布:
  1. 远程发布:触发CI工作流
  2. 本地发布:从本地仓库进行发布
如果存在工作流,优先使用远程发布;否则使用本地发布。

Documentation

文档

When running into errors during the release process, obtain additional help by reading the official documentation:
如果在发布过程中遇到错误,可通过阅读官方文档获取更多帮助: