Skip to content

plugin: update server-side swift framework guidance#85

Merged
gaelic-ghost merged 1 commit into
mainfrom
plugin/server-side-swift-hummingbird-vapor5
Jun 22, 2026
Merged

plugin: update server-side swift framework guidance#85
gaelic-ghost merged 1 commit into
mainfrom
plugin/server-side-swift-hummingbird-vapor5

Conversation

@gaelic-ghost

@gaelic-ghost gaelic-ghost commented Jun 22, 2026

Copy link
Copy Markdown
Owner

Summary:\n- Prefer Hummingbird's official hb CLI for fresh Hummingbird services while keeping template guidance as fallback/source inspection.\n- Add Vapor 5 alpha adoption guidance that keeps Vapor 4 as the stable default until Vapor 5 is stable.\n- Align server-side Swift plugin metadata and roadmap notes with the updated framework posture.\n\nVerification:\n- python3 -m json.tool plugins/server-side-swift/.codex-plugin/plugin.json\n- git diff --check origin/main...HEAD\n- uv run scripts/validate_socket_metadata.py

Summary by CodeRabbit

  • Documentation
    • Hummingbird guidance now recommends using the official CLI for new projects.
    • Clarified Vapor adoption posture: Vapor 4 is the stable default; Vapor 5 alpha is reserved for experimental evaluation and migration readiness only.
    • Enhanced documentation with updated tool references and source materials.

@gaelic-ghost gaelic-ghost added the documentation Improvements or additions to documentation label Jun 22, 2026
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Updates the server-side Swift plugin across five files to establish two new guidance postures: Hummingbird app creation should prefer the official hb CLI over the template repository, and Vapor 4 remains the stable default while Vapor 5 alpha is treated as explicitly experimental. Changes span the plugin manifest, agent rules, both skill documents, and the roadmap checklist.

Changes

Server-Side Swift Plugin: hb CLI + Vapor 5 Alpha Guidance

Layer / File(s) Summary
Plugin manifest, agent rules, and roadmap
ROADMAP.md, plugins/server-side-swift/AGENTS.md, plugins/server-side-swift/.codex-plugin/plugin.json
plugin.json keywords gain vapor-5 and hb; longDescription and defaultPrompt entries are updated to reference Vapor 5 alpha posture and hb CLI. AGENTS.md adds two local-rule bullets enforcing hb CLI preference and Vapor 4 as the stable default. ROADMAP.md records the completed ticket.
Hummingbird skill: hb CLI tooling
plugins/server-side-swift/skills/hummingbird-server-workflow/SKILL.md
hb added to allowed-tools; Source Check extended with hb CLI repo and Homebrew tap links; Planning Workflow updated to prefer hb for fresh apps; Project Creation rewritten to use brew tap/hb init with template repo kept only as conditional fallback.
Vapor skill: Vapor 5 alpha adoption posture
plugins/server-side-swift/skills/vapor-server-workflow/SKILL.md
Skill description, When To Use, and Source Check updated to cover Vapor 5 alpha; new "Vapor 5 Alpha Adoption" section added with step-by-step rules (label alpha as non-stable, pin prerelease revisions, inventory Vapor 4 dependencies, prohibit presenting alpha APIs as stable docs).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • gaelic-ghost/socket#54: Introduced the same plugin.json, AGENTS.md, and vapor-server-workflow/SKILL.md surfaces that this PR extends with Vapor 5 alpha and hb CLI guidance.
  • gaelic-ghost/socket#63: Updated the same Vapor/Hummingbird workflow docs with ecosystem and package-preference rules, which this PR further revises for hb CLI and Vapor 5 alpha posture.

Poem

🐇 Hop, hop, the hb CLI is here,
No more template detours, the path is clear!
Vapor 4 stands stable, Vapor 5 waits in alpha haze,
We pin our revisions and label our phase.
The rabbit writes docs with a careful paw —
alpha is alpha, by immutable law! 🌿

🚥 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 directly summarizes the main change: updating server-side Swift framework guidance across Hummingbird and Vapor documentation.
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 plugin/server-side-swift-hummingbird-vapor5

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 and usage tips.

@gaelic-ghost gaelic-ghost merged commit c057204 into main Jun 22, 2026
1 of 2 checks passed
@gaelic-ghost gaelic-ghost deleted the plugin/server-side-swift-hummingbird-vapor5 branch June 22, 2026 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant