Skip to content

docs(bundler): document manifest dynamic entries#5928

Open
killagu wants to merge 2 commits intonextfrom
agent/egg-doc/beef8554
Open

docs(bundler): document manifest dynamic entries#5928
killagu wants to merge 2 commits intonextfrom
agent/egg-doc/beef8554

Conversation

@killagu
Copy link
Copy Markdown
Contributor

@killagu killagu commented May 4, 2026

Summary

  • Document that metadata-only manifest generation records convention-based dynamic lookups for load units.
  • Clarify that the generated .egg/manifest.json records these lookups into resolveCache and fileDiscovery so bundled single-mode workers can resolve plugin agent hooks, extensions, and middleware discovered during runtime loading.

Validation

  • git diff --check origin/next..HEAD
  • pnpm exec oxfmt --check tools/egg-bundler/docs/output-structure.md

Summary by CodeRabbit

  • Documentation
    • Added documentation explaining how the Bundler records convention-based dynamic entries in startup manifests. This clarifies how bundled single-mode workers locate plugin agent hooks, extensions, and middleware at runtime.

Copilot AI review requested due to automatic review settings May 4, 2026 18:04
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ce84a05e-59dd-4c69-be05-580c1411de27

📥 Commits

Reviewing files that changed from the base of the PR and between 4a4e7d9 and 3e4da91.

📒 Files selected for processing (1)
  • tools/egg-bundler/docs/output-structure.md
✅ Files skipped from review due to trivial changes (1)
  • tools/egg-bundler/docs/output-structure.md

📝 Walkthrough

Walkthrough

Bundler docs now state that when a missing .egg/manifest.json is generated with metadataOnly: true, Egg records convention-based dynamic lookups from each load unit into the manifest’s resolveCache and fileDiscovery (covering agent, app, app/extend/*, and app/middleware/*) so single-mode bundled workers can resolve those entries at startup.

Changes

Documentation: Startup Manifest and Dynamic Entry Recording

Layer / File(s) Summary
Documentation
tools/egg-bundler/docs/output-structure.md
Added note describing that metadataOnly: true manifest generation populates manifest.resolveCache and manifest.fileDiscovery with convention-based dynamic lookups for agent, app, app/extend/*, and app/middleware/*, enabling bundled mode: 'single' workers to resolve plugin agent hooks, extensions, and middleware at startup.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A bundle so neat, a manifest true,
With metadata hints and conventions too,
Dynamic entries hum in startup light,
Single workers find hooks without the night!

🚥 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 'docs(bundler): document manifest dynamic entries' directly and clearly describes the main change—adding documentation about how the bundler records dynamic manifest entries during metadata-only generation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/egg-doc/beef8554

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
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

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

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 4, 2026

Deploying egg with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3e4da91
Status: ✅  Deploy successful!
Preview URL: https://7708c5fa.egg-cci.pages.dev
Branch Preview URL: https://agent-egg-doc-beef8554.egg-cci.pages.dev

View logs

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates @eggjs/egg-bundler documentation to clarify how manifest auto-generation in metadataOnly mode captures convention-based dynamic file lookups so bundled single-mode workers can resolve agent hooks, extensions, and middleware at runtime.

Changes:

  • Document that manifest generation in metadataOnly: true records conventional dynamic entries across load units.
  • Explain the practical impact for bundled single-mode workers (agent hooks, app/extend, app/middleware resolution).

Comment thread tools/egg-bundler/docs/output-structure.md Outdated
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 4, 2026

Deploying egg-v3 with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3e4da91
Status: ✅  Deploy successful!
Preview URL: https://2b2462c9.egg-v3.pages.dev
Branch Preview URL: https://agent-egg-doc-beef8554.egg-v3.pages.dev

View logs

Copy link
Copy Markdown
Contributor

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

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 updates the documentation for the egg-bundler output structure to explain the behavior when generating a missing startup manifest with metadataOnly set to true. It describes how convention-based dynamic entries are recorded to support single-mode workers in resolving plugin hooks and middleware. I have no feedback to provide on these changes.

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.

2 participants