Skip to content

docs(release): release-notes entries are opt-in — only severe releases need one (#1870 policy revision) - #2057

Merged
ranxianglei merged 1 commit into
masterfrom
2026-10-04_release-notes-optional
Oct 4, 2026
Merged

ranxianglei merged 1 commit into
masterfrom
2026-10-04_release-notes-optional

Conversation

@ranxianglei

Copy link
Copy Markdown
Owner

Policy change per owner (2026-10-04): 默认不需要写 release-notes 条目,只有严重版本需要写。

Previously (#1873): every stable release required an entry — the dispatch/publish gates aborted when missing. That blocked today's 0.1.183 one-click run at the entry gate.

Now: entries are opt-in severity declarations.

entry state gate behavior
absent (the default) ::notice::… shipping silently + pass
present validated + logged exactly as before

Changed:

  • .github/workflows/release-manual.yml — dispatch-time gate inverted (missing → notice+pass)
  • .github/workflows/release.yml — pre-publish gate inverted
  • .github/workflows/release-bugfix.yml — same
  • AGENTS.md §5 — step 4 bullet: "only SEVERE releases need an entry"
  • reference/release.md — step 4, one-click prerequisite, bugfix flow §157 wording
  • release-notes/README.md — opt-in note added to the rules

Untouched: tier semantics (#1977 silent-by-default, only critical visible), the companion-package validation workflow (release-notes.yml validates entries that EXIST), span aggregation in src/update-notes.ts (holes are fine — spans just cover the entries that exist). 0.1.183's existing entry (#2055) is unaffected.

Verified: 3× YAML parse OK; gate logic simulated both ways against the real package (present → validate, absent → notice+pass).

@github-actions

github-actions Bot commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

📦 Built Package Artifact

Branch: 2026-10-04_release-notes-optional (590331a)

Option A — Install this exact build (recommended)

npm install -g billion-context@0.0.2100-pr.2057.db6ae02

This exact version is immutable and reproducible. The rolling pr tag tracks the newest test build across all PRs.

Option B — Download artifact

  1. Download the artifact from the Actions run
  2. Extract the tarball and install:
tar xzf billion-context-pr2057.tgz
npm install -g package

Install instructions are refreshed on each push.

@ranxianglei
ranxianglei merged commit 3a7308a into master Oct 4, 2026
14 checks passed
@ranxianglei ranxianglei mentioned this pull request Oct 4, 2026
@ranxianglei
ranxianglei deleted the 2026-10-04_release-notes-optional branch October 15, 2026 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant