Repository navigation
docs: fix devsy build command reference - #1063
Merged
Merged
Conversation
## Doc area `sites/docs-devsy-sh/content/docs/developing-in-workspaces/continuous-integration.mdx` — the "Pre-building and pushing images" section. ## Drift found The docs referenced `devsy build` as the command to pre-build and publish a devcontainer image: ```sh devsy build --repository ghcr.io/my-org/my-devcontainer --tag latest --push ``` `build` is not a top-level command. In `cmd/root.go`, the registered root subcommands are `ci`, `config`, `context`, `env`, `feature`, `ide`, `machine`, `mcp`, `provider`, `secrets`, `snapshot`, `template`, `update`, `workspace`, and `internal`. There is no top-level `build` command, so `devsy build ...` would fail with "unknown command". `build` is a subcommand of `workspace` (`cmd/workspace/workspace.go` registers `NewBuildCmd`, `cmd/workspace/build.go` defines `Use: "build [flags] [workspace-path|workspace-name]"`). ## Correction Changed both the prose and the code sample to use `devsy workspace build`: ```sh devsy workspace build --repository ghcr.io/my-org/my-devcontainer --tag latest --push ``` ## Code verification performed - Confirmed `cmd/root.go` root subcommand list has no top-level `build`. - Confirmed `cmd/workspace/workspace.go:25` calls `cmd.AddCommand(NewBuildCmd(globalFlags))` and `cmd/workspace/build.go:40` defines the `build` subcommand. - Confirmed the documented flags exist for `devsy workspace build` in `cmd/workspace/build.go` `registerImageFlags`: `--repository` (`names.Repository`), `--tag` (`names.Tag`), and `--push` (`names.Push`) — all present in `pkg/flags/names/names.go`. - Checked open PRs; none address this drift. ## Verification (formatting gate) - `task cli:format` — clean. - `task cli:lint:ci` — 0 issues. - `task cli:test` — only the known pre-existing `pkg/git` `TestRepoClone*` failures (a stale assertion on `origin/main`, not caused by this docs-only change). No new failures introduced. This PR was created by an AI agent as part of an automated daily docs job.
✅ Deploy Preview for devsydev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for images-devsy-sh canceled.
|
Up to standards ✅🟢 Issues
|
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
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.
Doc area
sites/docs-devsy-sh/content/docs/developing-in-workspaces/continuous-integration.mdx— the "Pre-building and pushing images" section.Drift found
The docs referenced
devsy buildas the command to pre-build and publish a devcontainer image:buildis not a top-level command. Incmd/root.go, the registered root subcommands areci,config,context,env,feature,ide,machine,mcp,provider,secrets,snapshot,template,update,workspace, andinternal. There is no top-levelbuildcommand, sodevsy build ...would fail with "unknown command".buildis a subcommand ofworkspace(cmd/workspace/workspace.goregistersNewBuildCmd,cmd/workspace/build.godefinesUse: "build [flags] [workspace-path|workspace-name]").Correction
Changed both the prose and the code sample to use
devsy workspace build:Code verification performed
cmd/root.goroot subcommand list has no top-levelbuild.cmd/workspace/workspace.go:25callscmd.AddCommand(NewBuildCmd(globalFlags))andcmd/workspace/build.go:40defines thebuildsubcommand.devsy workspace buildincmd/workspace/build.goregisterImageFlags:--repository(names.Repository),--tag(names.Tag), and--push(names.Push) — all present inpkg/flags/names/names.go.Verification (formatting gate)
task cli:format— clean.task cli:lint:ci— 0 issues.task cli:test— only the known pre-existingpkg/gitTestRepoClone*failures (a stale assertion onorigin/main, not caused by this docs-only change). No new failures introduced.This PR was created by an AI agent as part of an automated daily docs job.