Skip to content

chore: tidy root files — drop pnpm cruft, fold changelog + release docs - #11

Merged
Div627 merged 1 commit into
mainfrom
chore/tidy-root-files
Jul 6, 2026
Merged

chore: tidy root files — drop pnpm cruft, fold changelog + release docs#11
Div627 merged 1 commit into
mainfrom
chore/tidy-root-files

Conversation

@Div627

@Div627 Div627 commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

🤔 This is a ...

  • 🆕 New feature
  • 🐞 Bug fix
  • 📝 Site / documentation improvement
  • 📽️ Demo improvement
  • 💄 Component style improvement
  • 🤖 TypeScript definition improvement
  • 📦 Bundle size optimization
  • ⚡️ Performance optimization
  • ⭐️ Feature enhancement
  • 🌐 Internationalization
  • 🛠 Refactoring
  • 🎨 Code style optimization
  • ✅ Test Case
  • 🔀 Branch merge
  • ⏩ Workflow
  • ⌨️ Accessibility improvement
  • ❓ Other (about what?)

🔗 Related Issues

Root directory was cluttered with stray pnpm files, two loose CHANGELOG files, and a standalone RELEASE.md whose tag→CI publish path wasn't actually usable.

💡 Background and Solution

Root-level tidy-up, no library/runtime behavior change:

  • Remove pnpm-lock.yaml + pnpm-workspace.yaml. The project uses npmpackage-lock.json is the lockfile and all CI runs npm ci / npm install. pnpm-workspace.yaml held only a junk placeholder (allowBuilds: esbuild: set this to true or false) and was never a real workspace.
  • Fold the changelog into changelog/. CHANGELOG.{zh-CN,en-US}.mdchangelog/CHANGELOG.{zh-CN,en-US}.md (basenames kept). Updated every reader/writer: docs-site/scripts/build-changelog.mjs, scripts/prepare-publish.mjs (still copies them to the npm dist root for discoverability), README links, and doc prose. Verified npm run build still lands dist/CHANGELOG.*.md at the publish root.
  • Simplify + consolidate the release flow. npm publish is documented as a local step (npm run release = npm run build && npm publish ./dist, publish-from-dist) instead of a tag-triggered CI job — that path needed an NPM_TOKEN repo secret to inject npm auth. Removed .github/workflows/release.yml, folded the flow into CLAUDE.md and AGENTS.md, and deleted the standalone RELEASE.md.

📝 Change Log

Language Changelog
🇺🇸 English --
🇨🇳 Chinese --

🤖 Generated with Claude Code

Root cleanup with no runtime/library behavior change:

- Remove pnpm-lock.yaml and pnpm-workspace.yaml. The project uses npm
  (package-lock.json; all CI runs npm ci/npm install). pnpm-workspace.yaml
  held only a junk placeholder and was never a real workspace.

- Move CHANGELOG.{zh-CN,en-US}.md into changelog/ (basenames kept). Update
  the readers/writers: docs-site/scripts/build-changelog.mjs,
  scripts/prepare-publish.mjs (still copies them to the npm dist root),
  README links, and the RELEASE/CLAUDE/print-changelog prose. Verified the
  full build still lands dist/CHANGELOG.*.md at the publish root.

- Simplify + consolidate the release flow. npm publish is now documented as
  a local step (npm run release = build + npm publish ./dist, publish-from-
  dist) rather than a tag-triggered CI job, since that would need an
  NPM_TOKEN repo secret. Remove .github/workflows/release.yml, fold the flow
  into CLAUDE.md and AGENTS.md, and delete the standalone RELEASE.md.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@Div627, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 44 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: 2e2ff88d-0500-40e5-abd1-f008d6954d63

📥 Commits

Reviewing files that changed from the base of the PR and between f237ee7 and 73e456b.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (13)
  • .github/workflows/release.yml
  • AGENTS.md
  • CLAUDE.md
  • README.en-US.md
  • README.md
  • RELEASE.md
  • changelog/CHANGELOG.en-US.md
  • changelog/CHANGELOG.zh-CN.md
  • docs-site/scripts/build-changelog.mjs
  • docs-site/src/demos/changelog/data.tsx
  • pnpm-workspace.yaml
  • scripts/prepare-publish.mjs
  • scripts/print-changelog.mjs

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands.

@socket-security

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updatedmarked@​18.0.5 ⏵ 18.0.310010010095 +180
Updatedtsx@​4.22.4 ⏵ 4.22.11001008291 -2100
Updatedmarkdown-it@​14.2.0 ⏵ 14.1.18699 -110089100

View full report

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request moves the changelog files into a dedicated changelog/ directory and updates all references, documentation, and build/publish scripts accordingly. It also documents the local release and npm publishing workflow in AGENTS.md and CLAUDE.md, clarifying that publishing is a local step rather than a tag-triggered CI workflow. I have no feedback to provide as there are no review comments.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@Div627
Div627 merged commit 7bd440e into main Jul 6, 2026
7 of 8 checks passed
@Div627
Div627 deleted the chore/tidy-root-files branch July 6, 2026 00:42
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