Skip to content

AI-native knowledge base & Evernote/Obsidian alternative with instant sync & native MCP. Free on Cloudflare or self-hosted via Docker.

fix: require release note commit coverage

tianma-if7224174cc1c2
diff --git a/docs/release.md b/docs/release.md
index ebd59cf1..6c5a08f2 100644
--- a/docs/release.md
+++ b/docs/release.md
@@ -16,6 +16,8 @@ Connect delivery is a separate, explicit operation documented in
- Authenticate GitHub CLI with access to `tianma-if/edgeever`.
- Commit all user-facing changes before starting the release.
- Ensure every English change bullet has a corresponding Chinese bullet.
+- Decide which bilingual bullet covers every commit since the previous formal
+ Release. Non-user-facing commits still require an explicit exclusion reason.
## Command
@@ -25,11 +27,35 @@ bun run release -- \
--issue-title "Improve the release workflow" \
--label enhancement \
--change-en "Run required release checks in parallel." \
- --change-zh "并行执行发布所需检查。"
+ --change-zh "并行执行发布所需检查。" \
+ --change-commit "abcdef1"
```
-Repeat `--change-en` and `--change-zh` in matching pairs when a Release contains
-multiple changes. Repeat `--label` when the tracking Issue needs multiple labels.
+Repeat `--change-en`, `--change-zh`, and `--change-commit` in matching groups
+when a Release contains multiple changes. The first `--change-commit` maps to
+the first English/Chinese bullet pair, the second maps to the second pair, and
+so on. Use comma-separated SHAs when one bullet covers multiple commits:
+
+```bash
+--change-commit "abcdef1,1234567"
+```
+
+Every commit in the previous-formal-Release-to-`HEAD` range must be covered by
+at least one bilingual bullet. Explicitly exclude a commit that has no public
+user impact with a concrete reason:
+
+```bash
+--ignore-commit "89abcde:test-only coverage"
+```
+
+The command fails before validation, Issue creation, version changes, or Draft
+creation if a commit is uncovered, an exclusion has no reason, or a referenced
+SHA is outside the Release range. Release version commits created by this
+script are recognized automatically when resuming a Draft. The resolved mapping
+and exclusion reasons are recorded in the tracking Issue for auditability, but
+are not added to the public Release notes.
+
+Repeat `--label` when the tracking Issue needs multiple labels.
Public Release notes contain only user-visible changes, their impact, and any
required upgrade or migration guidance. Type checks, build commands, signing,
notarization, and asset-audit details remain in GitHub Actions and the linked
@@ -51,10 +77,11 @@ The command calculates the next stable version and resets lower components:
becomes `2.0.0`. Commit prefixes may inform the choice, but do not select it
automatically because code scope and product impact are not equivalent.
-Use `--dry-run` to inspect the native rebuild plan and generated bilingual notes
-without changing local or GitHub state. `--skip-install` skips the post-release
-DMG installation and is intended for exceptional or non-macOS runs; normal
-maintainer releases should install and launch the published application.
+Use `--dry-run` to inspect commit coverage, the native rebuild plan, and
+generated bilingual notes without changing local or GitHub state.
+`--skip-install` skips the post-release DMG installation and is intended for
+exceptional or non-macOS runs; normal maintainer releases should install and
+launch the published application.
## Release Cadence and Platform Versions
@@ -83,23 +110,25 @@ API-only Release.
1. Verify `main`, the working tree, GitHub authentication, the latest formal
Release, and the local/remote commit relationship.
-2. Run Web type checking, mobile type checking, the Web production build, and
+2. Audit every commit since the latest formal Release. Require each commit to
+ map to a bilingual public change or an explicit non-user-facing exclusion.
+3. Run Web type checking, mobile type checking, the Web production build, and
release-planning tests concurrently.
-3. Calculate the explicit `patch`, `minor`, or `major` version bump, then use
+4. Calculate the explicit `patch`, `minor`, or `major` version bump, then use
`scripts/plan-native-release.mjs` to determine whether desktop and Android
assets must be rebuilt or can be reused. Only affected native versions are
updated.
-4. Create a bilingual tracking Issue, commit the version changes to `main`, push,
+5. Create a bilingual tracking Issue, commit the version changes to `main`, push,
and create a Draft Release with bilingual notes.
-5. Dispatch the desktop and Android asset workflows concurrently. The desktop
+6. Dispatch the desktop and Android asset workflows concurrently. The desktop
workflow builds arm64 and x64 packages on matching native runners, then
combines their update metadata. Verify filenames, sizes, and checksums before
publication.
-6. Publish the Release and wait only for the required desktop and Android
+7. Publish the Release and wait only for the required desktop and Android
post-publication audits.
-7. Print the Demo deployment run or workflow URL. Demo deployment continues in
+8. Print the Demo deployment run or workflow URL. Demo deployment continues in
the background and does not delay release completion.
-8. Link and close the tracking Issue, download the final DMG matching the
+9. Link and close the tracking Issue, download the final DMG matching the
maintainer Mac's architecture, verify its checksum and signature, replace
`/Applications/EdgeEver.app`, and launch it.
@@ -113,6 +142,8 @@ push-triggered Android build without skipping required release builds.
## Failure and Resume Behavior
- A validation or Draft asset failure leaves the Release unpublished.
+- An uncovered or invalidly excluded commit stops the command before it writes
+ local versions or creates any GitHub Issue or Release.
- If the process stops after the version commit and Draft creation, rerun the
same command. A Draft whose version and target match the current `main` commit
is resumed instead of creating another Issue, commit, or Release.
diff --git a/docs/release.zh-CN.md b/docs/release.zh-CN.md
index a0161e93..fc3b4364 100644
--- a/docs/release.zh-CN.md
+++ b/docs/release.zh-CN.md
@@ -13,6 +13,8 @@ EdgeEver 使用一条本地命令准备 Release。该命令会检查仓库、创
- GitHub CLI 已完成认证,并且有权访问 `tianma-if/edgeever`。
- 开始发布前,所有面向用户的改动都已提交。
- 每条英文更新说明都必须有对应的中文说明。
+- 明确上一个正式 Release 之后的每个提交由哪一组双语说明覆盖;即使提交不面向
+ 用户,也必须显式填写忽略原因。
## 命令
@@ -22,11 +24,32 @@ bun run release -- \
--issue-title "Improve the release workflow" \
--label enhancement \
--change-en "Run required release checks in parallel." \
- --change-zh "并行执行发布所需检查。"
+ --change-zh "并行执行发布所需检查。" \
+ --change-commit "abcdef1"
```
-如果一个 Release 包含多项改动,请成对重复传入 `--change-en` 和
-`--change-zh`。跟踪 Issue 需要多个 Label 时,可以重复传入 `--label`。
+如果一个 Release 包含多项改动,请按组重复传入 `--change-en`、
+`--change-zh` 和 `--change-commit`。第一项 `--change-commit` 对应第一组
+中英文说明,第二项对应第二组,以此类推。一条说明覆盖多个提交时,使用逗号
+分隔 SHA:
+
+```bash
+--change-commit "abcdef1,1234567"
+```
+
+从上一个正式 Release 到当前 `HEAD` 的每个提交都必须被至少一组双语说明覆盖。
+没有公开用户影响的提交需要填写具体原因后显式排除:
+
+```bash
+--ignore-commit "89abcde:仅增加测试覆盖"
+```
+
+如果存在未覆盖提交、忽略项没有原因,或 SHA 不属于本次 Release 区间,命令会
+在本地验证、创建 Issue、修改版本或创建 Draft 之前直接失败。续跑 Draft 时,
+脚本生成的 Release 版本提交会被自动识别。解析后的提交映射和忽略原因会记录在
+跟踪 Issue 中以便审计,但不会写入公开 Release 正文。
+
+跟踪 Issue 需要多个 Label 时,可以重复传入 `--label`。
公开 Release 说明只包含用户可感知的变化、影响以及必要的升级或迁移提醒。
类型检查、构建命令、签名、公证和资产审计等技术细节保留在 GitHub Actions
与关联跟踪 Issue 中,不再重复写入公开说明。
@@ -42,9 +65,9 @@ bun run release -- \
`+ minor` 得到 `1.7.0`,`+ major` 得到 `2.0.0`。提交前缀可以辅助判断,但
不会自动决定版本级别,因为代码改动类型不等同于产品影响。
-使用 `--dry-run` 可以只查看原生端重建计划和生成的双语说明,不修改本地或
-GitHub 状态。`--skip-install` 会跳过发布后的 DMG 安装,仅适用于特殊情况或
-非 macOS 环境;维护者正常发布时仍应安装并启动已发布的应用。
+使用 `--dry-run` 可以查看提交覆盖审计、原生端重建计划和生成的双语说明,
+且不会修改本地或 GitHub 状态。`--skip-install` 会跳过发布后的 DMG 安装,
+仅适用于特殊情况或非 macOS 环境;维护者正常发布时仍应安装并启动已发布的应用。
## 发布节奏与平台版本
@@ -69,19 +92,21 @@ GitHub 状态。`--skip-install` 会跳过发布后的 DMG 安装,仅适用于
1. 检查 `main`、工作区、GitHub 认证、上一个正式 Release,以及本地与远端的
提交关系。
-2. 并行执行 Web 类型检查、移动端类型检查、Web 生产构建和 Release 规划测试。
-3. 按显式选择的 `patch`、`minor` 或 `major` 计算版本,再使用
+2. 审计上一个正式 Release 之后的全部提交,要求每个提交关联一组双语公开说明,
+ 或带具体原因显式标记为不面向用户。
+3. 并行执行 Web 类型检查、移动端类型检查、Web 生产构建和 Release 规划测试。
+4. 按显式选择的 `patch`、`minor` 或 `major` 计算版本,再使用
`scripts/plan-native-release.mjs` 判断桌面端和 Android 资产需要重建还是
可以复用,并且只更新受影响原生端的版本。
-4. 创建双语跟踪 Issue,将版本变更提交并推送到 `main`,然后创建带双语说明的
+5. 创建双语跟踪 Issue,将版本变更提交并推送到 `main`,然后创建带双语说明的
Draft Release。
-5. 并行触发桌面端和 Android 资产工作流。桌面端工作流分别在匹配的原生 Runner
+6. 并行触发桌面端和 Android 资产工作流。桌面端工作流分别在匹配的原生 Runner
上构建 arm64 与 x64 包,再合并自动更新元数据;正式发布前检查文件名、大小
和校验和。
-6. 正式发布 Release,且只等待必要的桌面端和 Android 发布后资产审计。
-7. 输出 Demo 部署任务或工作流链接。Demo 在后台继续部署,不再延迟 Release
+7. 正式发布 Release,且只等待必要的桌面端和 Android 发布后资产审计。
+8. 输出 Demo 部署任务或工作流链接。Demo 在后台继续部署,不再延迟 Release
完成。
-8. 回链并关闭跟踪 Issue,下载与维护者 Mac 架构匹配的最终 DMG,验证校验和与
+9. 回链并关闭跟踪 Issue,下载与维护者 Mac 架构匹配的最终 DMG,验证校验和与
签名,覆盖 `/Applications/EdgeEver.app` 并启动。
Release 流程不会构建 Play AAB、启动 EAS iOS Build,也不会上传到移动端商店。
@@ -93,6 +118,8 @@ Release 流程不会构建 Play AAB、启动 EAS iOS Build,也不会上传到
## 失败与续跑
- 本地验证或 Draft 资产失败时,Release 会保持未发布状态。
+- 未覆盖的提交或格式不合法的忽略项会让命令在修改本地版本或创建任何 GitHub
+ Issue、Release 之前停止。
- 如果流程在版本提交和 Draft 创建后中断,重新执行同一条命令即可。脚本会识别
版本和目标提交都与当前 `main` 匹配的 Draft,不会重复创建 Issue、提交或
Release。
diff --git a/scripts/release.mjs b/scripts/release.mjs
index 1ed4bde2..6932177c 100644
--- a/scripts/release.mjs
+++ b/scripts/release.mjs
@@ -52,9 +52,12 @@ const usage = `Usage:
--issue-title "Release issue title" \\
--label bug \\
--change-en "English user-facing change" \\
- --change-zh "中文用户更新说明"
+ --change-zh "中文用户更新说明" \\
+ --change-commit "abcdef1"
-Repeat --change-en and --change-zh for multiple paired release bullets.
+Repeat --change-en, --change-zh, and --change-commit for multiple paired release bullets.
+Use comma-separated SHAs when one bullet covers multiple commits. Every other
+commit requires --ignore-commit "abcdef1:reason".
Options:
--bump <level> Required version bump: patch, minor, or major
@@ -63,6 +66,8 @@ Options:
--label <label> Required Issue label; may be repeated
--change-en <text> Required English release bullet; may be repeated
--change-zh <text> Required Chinese release bullet; may be repeated
+ --change-commit <sha,...> Commits covered by the corresponding bilingual bullet
+ --ignore-commit <sha:why> Explicitly exclude a non-user-facing commit; may be repeated
--skip-install Do not install the final DMG after publication
--dry-run Print the plan and generated notes without mutations
--help Show this help
@@ -76,6 +81,8 @@ export const parseReleaseArgs = (argv) => {
labels: [],
changesEn: [],
changesZh: [],
+ changeCommits: [],
+ ignoredCommits: [],
skipInstall: false,
dryRun: false,
help: false,
@@ -88,6 +95,8 @@ export const parseReleaseArgs = (argv) => {
["--label", "labels"],
["--change-en", "changesEn"],
["--change-zh", "changesZh"],
+ ["--change-commit", "changeCommits"],
+ ["--ignore-commit", "ignoredCommits"],
]);
for (let index = 0; index < argv.length; index += 1) {
@@ -142,9 +151,80 @@ export const parseReleaseArgs = (argv) => {
if (options.changesEn.length !== options.changesZh.length) {
throw new Error("--change-en and --change-zh must have the same count.");
}
+ if (options.changesEn.length !== options.changeCommits.length) {
+ throw new Error("Each bilingual change requires one corresponding --change-commit value.");
+ }
return options;
};
+const RELEASE_COMMIT_PATTERN = /^chore: release v\d+\.\d+\.\d+ \[skip ci\]$/;
+const COMMIT_REF_PATTERN = /^[0-9a-f]{7,40}$/i;
+
+const parseCommitRefs = (value, option) => {
+ const refs = value.split(",").map((item) => item.trim()).filter(Boolean);
+ if (refs.length === 0 || refs.some((ref) => !COMMIT_REF_PATTERN.test(ref))) {
+ throw new Error(`${option} must contain comma-separated commit SHAs with 7 to 40 hexadecimal characters.`);
+ }
+ return refs;
+};
+
+const resolveCommitRef = (ref, commits, option) => {
+ const matches = commits.filter((commit) => commit.sha.toLowerCase().startsWith(ref.toLowerCase()));
+ if (matches.length === 0) {
+ throw new Error(`${option} references ${ref}, which is not in the release commit range.`);
+ }
+ if (matches.length > 1) {
+ throw new Error(`${option} commit ${ref} is ambiguous; use a longer SHA.`);
+ }
+ return matches[0];
+};
+
+export const auditReleaseCommitCoverage = ({ commits, changeCommits, ignoredCommits }) => {
+ const mappings = changeCommits.map((value, index) => ({
+ changeIndex: index,
+ commits: parseCommitRefs(value, "--change-commit").map((ref) =>
+ resolveCommitRef(ref, commits, "--change-commit")
+ ),
+ }));
+ const coveredShas = new Set(mappings.flatMap((mapping) =>
+ mapping.commits.map((commit) => commit.sha)
+ ));
+ const ignored = ignoredCommits.map((value) => {
+ const separator = value.indexOf(":");
+ const ref = separator === -1 ? "" : value.slice(0, separator).trim();
+ const reason = separator === -1 ? "" : value.slice(separator + 1).trim();
+ if (!COMMIT_REF_PATTERN.test(ref) || !reason) {
+ throw new Error('--ignore-commit must use "<commit-sha>:<reason>".');
+ }
+ const commit = resolveCommitRef(ref, commits, "--ignore-commit");
+ if (coveredShas.has(commit.sha)) {
+ throw new Error(`Commit ${ref} cannot be both covered and ignored.`);
+ }
+ return { commit, reason };
+ });
+ const ignoredShas = new Set(ignored.map(({ commit }) => commit.sha));
+ if (ignoredShas.size !== ignored.length) {
+ throw new Error("A commit may only be ignored once.");
+ }
+
+ const automatic = commits
+ .filter((commit) => RELEASE_COMMIT_PATTERN.test(commit.subject))
+ .map((commit) => ({ commit, reason: "release automation commit" }));
+ const automaticShas = new Set(automatic.map(({ commit }) => commit.sha));
+ const uncovered = commits.filter((commit) =>
+ !coveredShas.has(commit.sha) && !ignoredShas.has(commit.sha) && !automaticShas.has(commit.sha)
+ );
+ if (uncovered.length > 0) {
+ throw new Error([
+ "Release notes do not account for every commit since the previous Release:",
+ ...uncovered.map((commit) => `- ${commit.sha.slice(0, 8)} ${commit.subject}`),
+ 'Cover each commit with --change-commit, or use --ignore-commit "<sha>:<reason>".',
+ ].join("\n"));
+ }
+
+ return { mappings, ignored: [...ignored, ...automatic] };
+};
+
export const nextVersion = (version, bump) => {
const match = /^(\d+)\.(\d+)\.(\d+)$/.exec(version);
if (!match) {
@@ -168,7 +248,7 @@ export const buildReleaseTitle = (tag) => {
return tag;
};
-export const buildIssueBody = ({ changesEn, changesZh }) => [
+export const buildIssueBody = ({ changesEn, changesZh, commitCoverageAudit }) => [
"## Summary",
"",
...changesEn.map((change) => `- ${change}`),
@@ -177,6 +257,17 @@ export const buildIssueBody = ({ changesEn, changesZh }) => [
"",
...changesZh.map((change) => `- ${change}`),
"",
+ ...(commitCoverageAudit ? [
+ "## Commit coverage audit",
+ "",
+ ...commitCoverageAudit.mappings.map((mapping) =>
+ `- Change ${mapping.changeIndex + 1}: ${mapping.commits.map((commit) => `\`${commit.sha.slice(0, 8)}\``).join(", ")}`
+ ),
+ ...commitCoverageAudit.ignored.map(({ commit, reason }) =>
+ `- Excluded \`${commit.sha.slice(0, 8)}\`: ${reason}`
+ ),
+ "",
+ ] : []),
"## Acceptance criteria",
"",
"- Required type checks, Web build, and native release planning tests pass.",
@@ -288,6 +379,29 @@ const changedFilesBetween = (baseRef, headRef) => run(
{ capture: true },
).split("\n").filter(Boolean);
+const releaseCommitsBetween = (baseRef, headRef) => run(
+ "git",
+ ["log", "--reverse", "--format=%H%x09%s", `${baseRef}..${headRef}`],
+ { capture: true },
+).split("\n").filter(Boolean).map((line) => {
+ const separator = line.indexOf("\t");
+ return {
+ sha: line.slice(0, separator),
+ subject: line.slice(separator + 1),
+ };
+});
+
+const printReleaseCoverageAudit = ({ audit, changesEn }) => {
+ console.log("[release] commit coverage audit:");
+ for (const mapping of audit.mappings) {
+ const commits = mapping.commits.map((commit) => commit.sha.slice(0, 8)).join(", ");
+ console.log(`[release] change ${mapping.changeIndex + 1} (${commits}): ${changesEn[mapping.changeIndex]}`);
+ }
+ for (const { commit, reason } of audit.ignored) {
+ console.log(`[release] ignored ${commit.sha.slice(0, 8)}: ${reason}`);
+ }
+};
+
const assertReleasePreconditions = ({ repository, previousTag }) => {
if (run("git", ["branch", "--show-current"], { capture: true }) !== "main") {
throw new Error("Releases must run directly from the main branch.");
@@ -673,6 +787,13 @@ const releaseMain = async (options) => {
if (changedFiles.length === 0) {
throw new Error(`There are no committed changes after ${previousTag}.`);
}
+ const releaseCommits = releaseCommitsBetween(previousTag, headShaBeforeRelease);
+ const commitCoverageAudit = auditReleaseCommitCoverage({
+ commits: releaseCommits,
+ changeCommits: options.changeCommits,
+ ignoredCommits: options.ignoredCommits,
+ });
+ printReleaseCoverageAudit({ audit: commitCoverageAudit, changesEn: options.changesEn });
const desktopPlan = planNativeRelease("desktop", changedFiles);
const mobilePlan = planNativeRelease("mobile", changedFiles);
@@ -711,7 +832,7 @@ const releaseMain = async (options) => {
options.issueTitle,
...options.labels.flatMap((label) => ["--label", label]),
"--body",
- buildIssueBody(options),
+ buildIssueBody({ ...options, commitCoverageAudit }),
], { capture: true });
const issueMatch = issueUrl.match(/\/issues\/(\d+)/);
if (!issueMatch) {
diff --git a/scripts/release.test.mjs b/scripts/release.test.mjs
index 186d45a5..c7cc0e3d 100644
--- a/scripts/release.test.mjs
+++ b/scripts/release.test.mjs
@@ -1,5 +1,6 @@
import { describe, expect, test } from "bun:test";
import {
+ auditReleaseCommitCoverage,
buildIssueBody,
buildReleaseNotes,
buildReleaseTitle,
@@ -23,6 +24,8 @@ describe("release automation", () => {
"Run checks in parallel.",
"--change-zh",
"并行运行检查。",
+ "--change-commit",
+ "abc1234",
]),
).toMatchObject({
issueTitle: "Improve release flow",
@@ -30,6 +33,7 @@ describe("release automation", () => {
labels: ["enhancement"],
changesEn: ["Run checks in parallel."],
changesZh: ["并行运行检查。"],
+ changeCommits: ["abc1234"],
});
});
@@ -72,6 +76,8 @@ describe("release automation", () => {
"Fix a bug.",
"--change-zh",
"修复问题。",
+ "--change-commit",
+ "abc1234",
])
).toThrow("--bump must be patch, minor, or major");
});
@@ -98,11 +104,100 @@ describe("release automation", () => {
const body = buildIssueBody({
changesEn: ["Parallel checks."],
changesZh: ["并行检查。"],
+ commitCoverageAudit: {
+ mappings: [{
+ changeIndex: 0,
+ commits: [{ sha: "aaaaaaaa11111111111111111111111111111111" }],
+ }],
+ ignored: [{
+ commit: { sha: "bbbbbbbb22222222222222222222222222222222" },
+ reason: "test-only coverage",
+ }],
+ },
});
expect(body).toContain("## Summary");
expect(body).toContain("- Parallel checks.");
expect(body).toContain("## 中文说明");
expect(body).toContain("- 并行检查。");
+ expect(body).toContain("## Commit coverage audit");
+ expect(body).toContain("- Change 1: `aaaaaaaa`");
+ expect(body).toContain("- Excluded `bbbbbbbb`: test-only coverage");
+ });
+
+ test("requires every bilingual change to map to commits", () => {
+ expect(() =>
+ parseReleaseArgs([
+ "--issue-title",
+ "Missing commit mapping",
+ "--bump",
+ "patch",
+ "--label",
+ "bug",
+ "--change-en",
+ "Fix a bug.",
+ "--change-zh",
+ "修复问题。",
+ ])
+ ).toThrow("--change-commit");
+ });
+
+ test("audits complete commit coverage across changes and explicit ignores", () => {
+ const commits = [
+ { sha: "aaaaaaaa11111111111111111111111111111111", subject: "feat: add resource actions" },
+ { sha: "bbbbbbbb22222222222222222222222222222222", subject: "test: cover resource actions" },
+ { sha: "cccccccc33333333333333333333333333333333", subject: "fix: stabilize editor" },
+ ];
+ const audit = auditReleaseCommitCoverage({
+ commits,
+ changeCommits: ["aaaaaaaa,cccccccc"],
+ ignoredCommits: ["bbbbbbbb:test-only coverage"],
+ });
+ expect(audit.mappings[0].commits.map((commit) => commit.sha)).toEqual([
+ commits[0].sha,
+ commits[2].sha,
+ ]);
+ expect(audit.ignored).toEqual([{ commit: commits[1], reason: "test-only coverage" }]);
+ });
+
+ test("blocks a release when a commit is missing from the notes audit", () => {
+ const commits = [
+ { sha: "aaaaaaaa11111111111111111111111111111111", subject: "feat: documented" },
+ { sha: "bbbbbbbb22222222222222222222222222222222", subject: "fix: accidentally omitted" },
+ ];
+ expect(() => auditReleaseCommitCoverage({
+ commits,
+ changeCommits: ["aaaaaaaa"],
+ ignoredCommits: [],
+ })).toThrow("bbbbbbbb fix: accidentally omitted");
+ });
+
+ test("requires valid ignore reasons and rejects covered commits as ignored", () => {
+ const commits = [
+ { sha: "aaaaaaaa11111111111111111111111111111111", subject: "feat: documented" },
+ ];
+ expect(() => auditReleaseCommitCoverage({
+ commits,
+ changeCommits: ["aaaaaaaa"],
+ ignoredCommits: ["aaaaaaaa:no public impact"],
+ })).toThrow("both covered and ignored");
+ expect(() => auditReleaseCommitCoverage({
+ commits,
+ changeCommits: [],
+ ignoredCommits: ["aaaaaaaa"],
+ })).toThrow("<commit-sha>:<reason>");
+ });
+
+ test("automatically accounts for a resumable release version commit", () => {
+ const releaseCommit = {
+ sha: "dddddddd44444444444444444444444444444444",
+ subject: "chore: release v1.10.3 [skip ci]",
+ };
+ const audit = auditReleaseCommitCoverage({
+ commits: [releaseCommit],
+ changeCommits: [],
+ ignoredCommits: [],
+ });
+ expect(audit.ignored).toEqual([{ commit: releaseCommit, reason: "release automation commit" }]);
});
test("requires reused assets to keep name, size, and digest", () => {