Skip to content

docs: fix devsy build command reference - #1063

Merged
skevetter merged 1 commit into
mainfrom
docs-keeper/fix-devsy-build-command-reference
Aug 15, 2026
Merged

skevetter merged 1 commit into
mainfrom
docs-keeper/fix-devsy-build-command-reference

Conversation

@devsy-app

@devsy-app devsy-app Bot commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

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:

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:

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.

## 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.
@netlify

netlify Bot commented Aug 15, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for devsydev ready!

Name Link
🔨 Latest commit 056f019
🔍 Latest deploy log https://app.netlify.com/projects/devsydev/deploys/6a805f8694e8a60008b4e965
😎 Deploy Preview https://deploy-preview-1063--devsydev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Aug 15, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for images-devsy-sh canceled.

Name Link
🔨 Latest commit 056f019
🔍 Latest deploy log https://app.netlify.com/projects/images-devsy-sh/deploys/6a805f8669d6af00084df9a2

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: run a review on demand. To trigger the first review automatically, go to your organization or repository integration settings. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@skevetter
skevetter marked this pull request as ready for review August 15, 2026 16:59
@skevetter
skevetter merged commit 0d77d77 into main Aug 15, 2026
27 checks passed
@skevetter
skevetter deleted the docs-keeper/fix-devsy-build-command-reference branch August 15, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant