docs(devcontainer): update README for PHP 8.4 and FrankenPHP#1476
docs(devcontainer): update README for PHP 8.4 and FrankenPHP#1476LukeTowers merged 1 commit intowintercms:developfrom
Conversation
WalkthroughThis pull request updates the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.devcontainer/README.md:
- Around line 48-53: The example in the "features" JSON leaves the bootstrap
feature enabled even though the text says to disable it; update the example so
the "./local-features/bootstrap-winter": "latest" entry is commented out or
removed from the "features" block (or shown as disabled) to match the
instruction, and ensure the README's example and the note about disabling
bootstrap-winter reference the same state; target the "features" object and the
"./local-features/bootstrap-winter" entry when making this change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 277bc739-ae95-4afb-bd12-603b1a4b7fdf
📒 Files selected for processing (1)
.devcontainer/README.md
| "features": { | ||
| "ghcr.io/devcontainers/features/common-utils:2": {}, | ||
| "ghcr.io/devcontainers/features/github-cli:1": {}, | ||
| // Comment the following feature if you wish to bootstrap and configure Winter manually (ie. you wish to use this for your own project) | ||
| //"./local-features/bootstrap-winter": "latest" | ||
| "./local-features/bootstrap-winter": "latest" | ||
| }, |
There was a problem hiding this comment.
Example contradicts “disable bootstrap-winter” instruction
Line 45 says to disable by commenting out the feature, but Line 52 still shows ./local-features/bootstrap-winter enabled in the example. This can mislead users into keeping bootstrap enabled.
Suggested doc fix
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {},
"ghcr.io/devcontainers/features/github-cli:1": {},
// Comment the following feature if you wish to bootstrap and configure Winter manually (ie. you wish to use this for your own project)
- "./local-features/bootstrap-winter": "latest"
+ // "./local-features/bootstrap-winter": "latest"
},📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "features": { | |
| "ghcr.io/devcontainers/features/common-utils:2": {}, | |
| "ghcr.io/devcontainers/features/github-cli:1": {}, | |
| // Comment the following feature if you wish to bootstrap and configure Winter manually (ie. you wish to use this for your own project) | |
| //"./local-features/bootstrap-winter": "latest" | |
| "./local-features/bootstrap-winter": "latest" | |
| }, | |
| "features": { | |
| "ghcr.io/devcontainers/features/common-utils:2": {}, | |
| "ghcr.io/devcontainers/features/github-cli:1": {}, | |
| // Comment the following feature if you wish to bootstrap and configure Winter manually (ie. you wish to use this for your own project) | |
| // "./local-features/bootstrap-winter": "latest" | |
| }, |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.devcontainer/README.md around lines 48 - 53, The example in the "features"
JSON leaves the bootstrap feature enabled even though the text says to disable
it; update the example so the "./local-features/bootstrap-winter": "latest"
entry is commented out or removed from the "features" block (or shown as
disabled) to match the instruction, and ensure the README's example and the note
about disabling bootstrap-winter reference the same state; target the "features"
object and the "./local-features/bootstrap-winter" entry when making this
change.
Update devcontainer README to align with Winter CMS Docker image migration from Apache 2 to FrankenPHP
Summary by CodeRabbit