Skip to content

feat(repo): move changelog to separate files (closes #318) - #320

Merged
ranxianglei merged 2 commits into
masterfrom
2026-08-17_changelog-separate-file
Aug 17, 2026
Merged

ranxianglei merged 2 commits into
masterfrom
2026-08-17_changelog-separate-file

Conversation

@ranxianglei

Copy link
Copy Markdown
Owner

What

Move the embedded changelog out of the main READMEs into dedicated files (closes #318, @HaleTom):

Before After
README.md ~1307 lines (changelog section ~810) README.md 499 lines + pointer section
README.zh-CN.md ~1214 lines (更新日志 ~765) README.zh-CN.md 453 lines + pointer section
— CHANGELOG.md (new, 67 entries, verbatim)
— CHANGELOG.zh-CN.md (new, 63 entries, verbatim)

Changes

  • README.md / README.zh-CN.md — changelog sections replaced by heading + one-line link; all other content untouched (## License / ## 许可证 etc. intact).
  • CHANGELOG.md / CHANGELOG.zh-CN.md — full release history moved verbatim (all ### v{VERSION} entry titles diff-checked identical to the old README sections, incl. top entry ### v1.14.21).
  • scripts/ci/check-pr.sh — check 4 (version-bump ⇒ changelog updated) repointed from the READMEs to CHANGELOG.md / CHANGELOG.zh-CN.md (change-detection + ### v{VERSION} grep + hint text).
  • AGENTS.md — 4 convention sites updated: §5.1.1 never-bump-version rule, §5.4.1 PR-checks table, §5.4.2 release step 2 (now "add entry at the top"), prerelease step 3.
  • devlog/2026-08-17_changelog-separate-file/ — REQ + WORKLOG.

Verification

  • npm test: 1003/1003 pass (no runtime code touched — docs + CI script only)
  • ./scripts/ci/check-pr.sh: all checks ✓
  • entry-title diff old-vs-new: identical (67 en / 63 zh)
  • no in-repo anchor links pointed at README.md#changelog (verified)
  • npm package content unchanged (CHANGELOG files are not in verify-package.mjs's packaged list)

Release-branch note

Future release PRs must add ### v{VERSION} entries to CHANGELOG.md / CHANGELOG.zh-CN.md (not the READMEs) — the updated CI check enforces this fail-closed.

Extract full release history from README.md (67 entries) and README.zh-CN.md (63 entries) into dedicated CHANGELOG.md / CHANGELOG.zh-CN.md. READMEs keep a one-line pointer. Repoint CI check-pr.sh check 4 and AGENTS.md conventions at the new files. No runtime code touched; npm package content unchanged.
…d at comment step; rerun collides on version 1.14.21-pr.320.35)
@github-actions

Copy link
Copy Markdown
Contributor

📦 Built Plugin Artifact

Branch: 2026-08-17_changelog-separate-file (a363fdd)

Option A — Install from npm PR tag (recommended)

opencode plugin opencode-acp@pr-320 --global

Each push to this PR publishes a new version under the pr-320 npm tag.

Option B — Install from GitHub

opencode plugin "github:ranxianglei/opencode-acp#2026-08-17_changelog-separate-file" --global

Option C — Download artifact

  1. Download the artifact from the Actions run
  2. Extract the tarball and install:
tar xzf opencode-acp-pr320.tgz
cp -r package/dist ~/.cache/opencode/packages/opencode-acp@latest/node_modules/opencode-acp/dist
  1. Restart opencode to pick up changes.

This comment is automatically updated on each push.

@ranxianglei
ranxianglei merged commit 0a364e1 into master Aug 17, 2026
6 checks passed
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.

[Feature]: Move Changelog to separate file

1 participant