Skip to content

chore(docs): increase vitepress build memory limit - #396

Closed
xuanlid wants to merge 3 commits into
opentiny:developfrom
xuanlid:fix/node-size
Closed

chore(docs): increase vitepress build memory limit#396
xuanlid wants to merge 3 commits into
opentiny:developfrom
xuanlid:fix/node-size

Conversation

@xuanlid

@xuanlid xuanlid commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added configuration options to control local search and build minification.
    • Documentation builds now use increased memory capacity for improved reliability.
    • Expanded access to Tiny Vue components in documentation and demos, including buttons, inputs, selections, dialogs, tabs, sliders, switches, and tooltips.
    • Improved local component integration for more consistent documentation previews.
  • Chores
    • Continuous integration documentation builds disable local search and minification for streamlined processing.
    • Dependency lockfiles are now tracked for more reproducible builds.

@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

Next included review available in 6 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1be4852a-9f75-43a5-a12e-adeacf501833

📥 Commits

Reviewing files that changed from the base of the PR and between e2557ac and 8b36464.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • .github/workflows/pr-ci-build.yml
  • docs/package.json

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 6e147011-d29a-403f-81a0-427d2cd006a1

📥 Commits

Reviewing files that changed from the base of the PR and between abdcdd5 and e2557ac.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • .github/workflows/pr-ci-build.yml
  • .gitignore
  • docs/package.json
💤 Files with no reviewable changes (1)
  • .gitignore

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

The documentation site now resolves @opentiny/vue to a local Tiny Vue runtime and exports configured components. VitePress supports environment-controlled local search and minification. CI uses a frozen lockfile, hashes the lockfile in its cache key, and builds with an 8192 MB Node.js heap.

Changes

Documentation build controls

Layer / File(s) Summary
Tiny Vue runtime integration
docs/.vitepress/tiny-vue.ts, docs/.vitepress/tiny-vue-runtime.ts, docs/package.json
The runtime exports 15 Tiny Vue components, Button, Switch, and Notify. It provides conventional and Tiny* component names. The required packages use version ^3.20.0.
VitePress environment controls
docs/.vitepress/config.mts
VitePress aliases @opentiny/vue to the local runtime. VP_BUILD_MINIFY controls minification. VP_LOCAL_SEARCH controls local search.
CI build resource wiring
.github/workflows/pr-ci-build.yml, docs/package.json
The workflow uses a frozen lockfile, includes pnpm-lock.yaml in the cache key, and disables local search and minification. The build script raises the Node.js heap limit to 8192 MB.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to e2557

This documentation build configuration change has no actionable merge-blocking risk remaining and is merge-ready after normal checks and review.

Sequence Diagram(s)

sequenceDiagram
  participant CIWorkflow
  participant VitePressConfig
  participant TinyVueRuntime
  participant VuePackages
  participant VitePressBuild
  CIWorkflow->>VitePressConfig: Set VP_LOCAL_SEARCH=false and VP_BUILD_MINIFY=false
  VitePressConfig->>TinyVueRuntime: Resolve `@opentiny/vue`
  TinyVueRuntime->>VuePackages: Load Tiny Vue components
  VitePressConfig->>VitePressBuild: Apply search and minification settings
  VitePressBuild-->>CIWorkflow: Build documentation with 8192 MB heap
Loading

Suggested reviewers: gene9831

Poem

A rabbit maps each Tiny name

The local runtime joins the frame
Search and minify follow the cue
Frozen locks keep builds true
More heap helps the docs proclaim

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately identifies the documented build memory increase from 4096 MB to 8192 MB. This is a central change in the pull request, although the title does not mention the additional dependenc…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 3…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title accurately identifies the documented build memory increase from 4096 MB to 8192 MB. This is a central change in the pull request, although the title does not mention the additional dependency, caching, and runtime configuration updates.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 3 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

✅ Preview build completed successfully!

Click the image above to preview.
Preview will be automatically removed when this PR is closed.

@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

🧹 Preview Cleaned Up

The preview deployment has been removed.

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