Skip to content

Remove the wasp start db alias - #5399

Open
infomiho wants to merge 4 commits into
issue-4479-db-commands-auto-startfrom
issue-4479-drop-start-db-alias
Open

infomiho wants to merge 4 commits into
issue-4479-db-commands-auto-startfrom
issue-4479-drop-start-db-alias

Conversation

@infomiho

@infomiho infomiho commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

Description

All the db commands live under wasp db * so I felt this is the right clean up.

Agreement

  • This is a small, obvious fix (typo, docs corrections, clear small bug with a test).
  • A maintainer agreed on the approach beforehand:

Type of change

  • 🔧 Just code/docs improvement
  • 🐞 Bug fix
  • 🚀 New/improved feature
  • 💥 Breaking change

Checklist

  • I tested my change in a Wasp app to verify that it works as intended.

  • 🧪 Tests and apps:

    • I added unit tests for my change.
    • (if you fixed a bug) I added a regression test for the bug I fixed.
    • (if you added/updated a feature) I added/updated e2e tests in examples/kitchen-sink/e2e-tests.
    • (if you added/updated a feature) I updated the starter templates in waspc/data/Cli/templates, as needed.
    • (if you added/updated a feature) I updated the example apps in examples/, as needed.
      • (if you updated examples/tutorials) I updated the tutorial in the docs (and vice versa).
  • 📜 Documentation:

    • (if you added/updated a feature) I added/updated the documentation in web/docs/.
  • 🆕 Changelog: (if change is more than just code/docs improvement)

    • I updated waspc/ChangeLog.md with a user-friendly description of the change.
    • (if you did a breaking change) I added a step to the current migration guide in web/docs/migration-guides/.
    • I bumped the version in waspc/waspc.cabal to reflect the changes I introduced.

@infomiho
infomiho added this pull request to stack #5310 November 19, 2026 14:38
@infomiho infomiho changed the title issue 4479 drop start db alias Remove the wasp start db alias Nov 19, 2026
@infomiho
infomiho temporarily deployed to railway-deploy-test November 19, 2026 14:54 — with GitHub Actions Inactive
@pkg-pr-new

pkg-pr-new Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

@wasp/spec

npx https://pkg.pr.new/@wasp/spec@5399

@wasp/cli

npx https://pkg.pr.new/@wasp/cli@5399

@wasp/cli-darwin-arm64-unknown

npx https://pkg.pr.new/@wasp/cli-darwin-arm64-unknown@5399

@wasp/cli-linux-arm64-glibc

npx https://pkg.pr.new/@wasp/cli-linux-arm64-glibc@5399

@wasp/cli-linux-x64-glibc

npx https://pkg.pr.new/@wasp/cli-linux-x64-glibc@5399

@wasp/cli-linux-x64-musl

npx https://pkg.pr.new/@wasp/cli-linux-x64-musl@5399

commit: e9b46db

@infomiho
infomiho force-pushed the issue-4479-drop-start-db-alias branch from e7af890 to f78801a Compare November 19, 2026 15:34
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

Deploying wasp-docs-on-main with  Cloudflare Pages  Cloudflare Pages

Latest commit: e9b46db
Status: ✅  Deploy successful!
Preview URL: https://19c2d7bf.wasp-docs-on-main.pages.dev
Branch Preview URL: https://issue-4479-drop-start-db-ali.wasp-docs-on-main.pages.dev

View logs

@infomiho
infomiho force-pushed the issue-4479-drop-start-db-alias branch from f78801a to 57ad62d Compare November 19, 2026 15:58
@infomiho
infomiho force-pushed the issue-4479-drop-start-db-alias branch from 57ad62d to 004e950 Compare November 20, 2026 10:31
@infomiho
infomiho removed this pull request from stack #5310 November 20, 2026 10:32
@infomiho
infomiho added this pull request to stack #5428 November 20, 2026 10:32
@infomiho
infomiho temporarily deployed to railway-deploy-test November 20, 2026 10:45 — with GitHub Actions Inactive
@infomiho
infomiho force-pushed the issue-4479-drop-start-db-alias branch from 004e950 to ef52eb5 Compare November 20, 2026 13:11
@infomiho
infomiho temporarily deployed to railway-deploy-test November 20, 2026 13:19 — with GitHub Actions Inactive
@infomiho
infomiho force-pushed the issue-4479-drop-start-db-alias branch from ef52eb5 to f692ff1 Compare November 20, 2026 13:52
@infomiho
infomiho temporarily deployed to railway-deploy-test November 20, 2026 13:57 — with GitHub Actions Inactive
@infomiho
infomiho marked this pull request as ready for review November 20, 2026 14:19
@infomiho
infomiho requested review from a team and sodic November 20, 2026 14:19

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Important

Current setup instructions still invoke the removed command.

Approach: Consolidating database commands under wasp db is sound, but the removal needs corresponding documentation updates.

Reviewed changes across CLI dispatch, module registration, help output, e2e helpers, and the changelog.

  • Command removal: Removes wasp start db and its command constructor while preserving wasp db start.
  • Module and help: Moves database startup into Command.Db.Start, updates Cabal registration, and corrects parser help.
  • Tests and release notes: Switches the missing-spec test to the supported command and documents the breaking change.

⚠️ Current setup instructions invoke the removed command

The latest database documentation, CLI reference, and maintained example READMEs still tell users to run wasp start db, including custom-image setup commands. After this change, those commands reach wasp start's parser and fail on the positional db argument, so following the published instructions no longer works.

Technical details
# Update maintained references to the removed command

## Affected sites
- `web/docs/features/data/databases.md:82–128` — dev-database instructions and custom-image examples.
- `web/docs/advanced/cli.md:39–42,117` — command listing and description.
- `web/docs/advanced/git-worktrees.md:73,100`, `web/docs/deployment/local-testing.md:25`, and `web/docs/deployment/database.md:11` — additional current instructions.
- `examples/ask-the-documents/README.md:34`, `examples/kitchen-sink/README.md:52`, `examples/waspello/README.md:25`, and `examples/waspleau/README.md:13` — maintained example setup instructions.
- `packages/wasp-app-runner/README.md:91` — reference to the removed command.

## Required outcome
- Current documentation and maintained examples use `wasp db start`, or explain automatic startup where appropriate, preserving custom database options.
- Regenerate affected Markdown and e2e snapshots through the repository tasks rather than editing them manually. Leave historical versioned docs and historical blog posts unchanged.

Source examples: database instructions, CLI reference, custom-image example setup.

Pullfrog  | Fix it ➔ | View workflow run | Using gpt-6.1-sol | 𝕏

@infomiho
infomiho force-pushed the issue-4479-drop-start-db-alias branch 3 times, most recently from 18a6b9e to 7eccb3a Compare November 20, 2026 20:22
@infomiho
infomiho force-pushed the issue-4479-drop-start-db-alias branch 2 times, most recently from c15771e to 7c4c52a Compare November 20, 2026 20:25
@infomiho
infomiho force-pushed the issue-4479-drop-start-db-alias branch from 7c4c52a to e9b46db Compare November 20, 2026 20:25
@infomiho
infomiho deployed to fly-deploy-test November 20, 2026 20:35 — with GitHub Actions Active
@infomiho
infomiho deployed to railway-deploy-test November 20, 2026 20:35 — with GitHub Actions Active

This branch was successfully deployed

2 active deployments
fly-deploy-test — e9b46db0 Deployed Nov 20, 2026 by infomiho via deploy-test / Test Fly deployment #15783
railway-deploy-test — e9b46db0 Deployed Nov 20, 2026 by infomiho via deploy-test / Test Railway deployment #15783
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.

1 participant