feat(workspace): add down alias for workspace delete (#1211) - #1215
Draft
skevetter wants to merge 1 commit into
Draft
feat(workspace): add down alias for workspace delete (#1211)#1215skevetter wants to merge 1 commit into
skevetter wants to merge 1 commit into
Conversation
Add 'down' as an alias for 'devsy workspace delete' to match common Docker Compose mental models without changing existing teardown semantics. - Register 'down' in DeleteCmd.Aliases - Update Long description noting full Devsy teardown and Compose down mapping - Add CLI contract tests for alias registration, command resolution, help text, and shell completion - Update documentation in stop-and-delete-a-workspace.mdx Closes #1211
✅ Deploy Preview for images-devsy-sh canceled.
|
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks 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 |
✅ Deploy Preview for devsydev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implements
devsy workspace downas an alias of the canonicaldevsy workspace deletecommand following the design in #1211.Motivation
Users familiar with Docker Compose often expect
devsy workspace downas the inverse ofdevsy workspace up. Devsy's compose-backed teardown already executes Docker Composedown, whileworkspace stopowns reversible suspension semantics. Addingdownas an exact Cobra alias ofworkspace deletealigns ergonomics with user mental models without introducing unnecessary lifecycle or state divergence.Changes
CLI Alias & Command Description (
cmd/workspace/delete.go):"down"todeleteCmd.Aliases([]string{"rm", "down"}).deleteCmd.Longto clarify thatdownandrmperform the same full Devsy workspace teardown, noting Docker/Podman Composedownbehavior for Compose-backed workspaces.CLI Contract Tests (
cmd/workspace/delete_test.go):TestDeleteCmd_Aliases: Assertsrmanddownare registered aliases.TestDeleteCmd_Resolution: Assertsdelete,rm,down, anddown <workspace>resolve to the canonicaldeletecommand.TestDeleteCmd_HelpExposesDownAlias: Asserts command help output exposesdownandrmunderAliases:.TestDeleteCmd_Completion: Asserts generated shell completion suggestions includedown.Documentation (
sites/docs-devsy-sh/content/docs/developing-in-workspaces/stop-and-delete-a-workspace.mdx):devsy workspace downunder Stop or Delete a Workspace, clarifying its relationship withdeleteandstop.Verification
go test -v -run '^TestDeleteCmd' ./cmd/workspacegolangci-lint fmtandgofmtgolangci-lint run --fast-onlycoderabbit reviewreported no findings (0 issues across all 3 files)Closes #1211