Skip to content

docs: upgrade guides still describe check-only wheels upgrade + manual zip swap #3045

Description

@bpamiri

After #3039, wheels upgrade apply performs the swap (explicit verb; backup-by-default). The following guide pages still describe the old workflow — check-only wheels upgrade with a manual vendor/wheels/ zip swap:

Pages to update

web/sites/guides/src/content/docs/v4-0-0/command-line-tools/wheels-commands/upgrade.mdx

The entire page describes wheels upgrade as a "read-only scanner" that never touches files. The frontmatter description, synopsis, and "What gets updated" section all need updating to document wheels upgrade apply as the swap verb (with backup-by-default, --nobackup, and the pre-swap recovery announcement). The current "What gets updated" section says:

Project `vendor/wheels/`: swap the directory manually, or regenerate the app skeleton against the new release and port your `app/` into it.

This should now read: run `wheels upgrade apply`.

web/sites/guides/src/content/docs/v4-0-0/start-here/release-channels.mdx (line 199)

wheels upgrade check --to=<version>

…followed by "or just re-scaffold the app's `vendor/wheels/` from a fresh `wheels new`" — needs an `apply` path added alongside `check`.

web/sites/guides/src/content/docs/v4-0-0/upgrading/3x-to-4x.mdx (line 389)

wheels upgrade check

This is the recommended upgrade CLI command under "Deprecating `box wheels upgrade`". After #3039, the full sequence is `check` first, then `apply`.

References

🤖 Generated with Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions