Skip to content

docs: pin codemod to v0.18.7 for migration recipe #33522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
danielroe merged 1 commit into from
Oct 21, 2025
Merged

docs: pin codemod to v0.18.7 for migration recipe #33522

danielroe merged 1 commit into from
Oct 21, 2025

Conversation

@Flo0806
Copy link
Member

@Flo0806 Flo0806 commented Oct 20, 2025

🔗 Linked issue

fixes: codemod/codemod#1710
fixes: #33519

📝 Description

Pins codemod version to 0.18.7 in the Nuxt 4 migration guide due to a bug in later versions.

📦 Changes

  • Updated all package manager commands (npm, yarn, pnpm, bun) to use [email protected] instead of @latest

✅ Checklist

  • Documentation updated for all package managers
  • Version pinned consistently across all examples

@Flo0806 Flo0806 requested a review from danielroe as a code owner October 20, 2025 06:41
@bolt-new-by-stackblitz
Copy link

bolt-new-by-stackblitz bot commented Oct 20, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@coderabbitai
Copy link

coderabbitai bot commented Oct 20, 2025

Walkthrough

The documentation file docs/1.getting-started/18.upgrade.md is updated to pin the codemod version to 0.18.7 instead of using the latest version. This change is applied across four separate code blocks representing different package managers: npm, yarn, pnpm, and bun. Each block is updated with an identical command modification and accompanied by an explanatory comment. The surrounding documentation structure and content remain unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Rationale: This change consists of repetitive, homogeneous documentation updates across four identical code blocks. Each modification follows the same pattern—replacing "latest" with "0.18.7" and adding a consistent comment. No functional code, logic, or structural changes are involved. The scope is limited to a single documentation file with straightforward version pinning.

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "docs: pin codemod to v0.18.7 for migration recipe" directly and clearly describes the main change in the changeset. It is concise, specific, and accurately summarises the primary objective of pinning the codemod version to 0.18.7 in the migration documentation. A teammate scanning the history would immediately understand that this PR updates documentation to specify a fixed codemod version.
Linked Issues Check ✅ Passed The code changes fully comply with the requirements from both linked issues. Issue #1710 and #33519 specify the need to update Nuxt documentation to instruct users to use [email protected] instead of @latest for the migration recipe. The pull request confirms that all package manager commands (npm, yarn, pnpm, bun) have been updated consistently to pin this version in the docs/1.getting-started/18.upgrade.md file, directly addressing the documented requirements.
Out of Scope Changes Check ✅ Passed All documented changes are directly scoped to the stated objectives. The changeset involves only documentation updates to pin the codemod version to 0.18.7 across all package manager examples, with no additional logic, error handling, or unrelated modifications introduced. The changes are contained to the upgrade documentation file and are entirely aligned with the requirements from the linked issues.
Description Check ✅ Passed The pull request description is directly related to the changeset and provides appropriate context. It clearly explains the purpose of the change (fixing a bug in later codemod versions), references the linked issues, outlines what was changed (pinning across all four package managers), and includes a completed checklist. The description is sufficiently detailed to convey the nature and rationale of the documentation updates.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b7ed1d3 and 5d6992c.

📒 Files selected for processing (1)
  • docs/1.getting-started/18.upgrade.md (1 hunks)
🔇 Additional comments (1)
docs/1.getting-started/18.upgrade.md (1)

223-241: Consistent version pinning across all package managers with clear rationale.

This update correctly pins codemod to v0.18.7 for the main migration recipe across all four package managers. The explanatory comment referencing the GitHub issue (codemod/codemod#1710) provides helpful context for users and maintainers. Command syntax is correct for each package manager, and the changes directly address the documented Windows compatibility issue.

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.

danielroe
danielroe approved these changes Oct 21, 2025
View reviewed changes
Copy link
Member

@danielroe danielroe left a comment

Choose a reason for hiding this comment

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

thanks! let's keep an eye and revert whenever we can.

@danielroe danielroe merged commit 60d984b into nuxt:main Oct 21, 2025
8 of 9 checks passed
This was referenced Oct 21, 2025
Merged
Closed
danielroe pushed a commit that referenced this pull request Oct 25, 2025
@Flo0806 @danielroe
docs: pin codemod to v0.18.7 for migration recipe (#33522)
cf6aae6
@github-actions github-actions bot mentioned this pull request Oct 25, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@danielroe danielroe danielroe approved these changes

Assignees

No one assigned

Labels

4.x documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Nuxt4 upgrade recipe found error Nuxt4 upgrade recipe found error

2 participants

@Flo0806 @danielroe