Uh oh!
There was an error while loading. Please reload this page.
feat(cmd): add run-user-commands lifecycle command - #203
Merged
Conversation
Add a new CLI command that connects to an already-running devcontainer and executes lifecycle commands (postCreateCommand, postStartCommand, postAttachCommand) in order. This enables CI/CD pipelines to trigger lifecycle hooks on existing containers without a full `up` cycle. Includes a hidden `runUserCommands` camelCase alias for devcontainer CLI compatibility and outputs the JSON result envelope on stdout.
✅ Deploy Preview for devsydev canceled.
|
📝 WalkthroughWalkthroughA new ChangesNew run-user-commands CLI Feature
Sequence DiagramsequenceDiagram
actor User
participant CLI as run-user-commands
participant Config as Dev Config Loader
participant Container as Docker Container
User->>CLI: Execute with workspace-folder & id-labels
CLI->>Config: Load dev config & resolve workspace
Config-->>CLI: Workspace & container ID
CLI->>Container: Run postCreateCommand (docker exec)
Container-->>CLI: ✓ or error
CLI->>Container: Run postStartCommand (docker exec)
Container-->>CLI: ✓ or error
CLI->>Container: Run postAttachCommand (docker exec)
Container-->>CLI: ✓ or error
CLI-->>User: Write result JSON to stderr
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
- Write JSON envelope to stderr (not stdout) so subprocess output doesn't corrupt the parseable envelope - Register camelCase alias as a separate hidden command instead of using Cobra's visible Aliases field - Remove unnecessary devcontainerGetRunnerID wrapper function - Sort env map keys for deterministic arg ordering
skevetter
marked this pull request as ready for review
May 4, 2026 10:35
skevetter
enabled auto-merge (squash)
May 4, 2026 10:35
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@cmd/runusercommands.go`:
- Around line 181-184: The hook's stderr is currently forwarded to os.Stderr
inside execLifecycleHook which mixes diagnostics with the JSON envelope written
later by params.helper.Run; change execLifecycleHook (and where it's invoked) to
capture hook stderr into a separate io.Writer (e.g., a bytes.Buffer or a
dedicated params.hookStderr) instead of passing os.Stderr, pass that buffer into
params.helper.Run invocations (the call site using params.helper.Run(params.ctx,
args, os.Stdin, os.Stdout, os.Stderr)), and ensure the JSON envelope is written
only to os.Stdout; emit any captured hook stderr to os.Stderr (or into a
separate diagnostics channel/field) outside or before/after the envelope so it
cannot corrupt the JSON output.
- Around line 91-94: The call to devcconfig.WriteResultJSON in the end of the
command currently discards its error; change the code in the function containing
user := devcconfig.GetRemoteUser(result) so that the returned error from
devcconfig.WriteResultJSON(os.Stderr, params.containerID, user, params.workdir)
is checked and propagated (or logged and returned) instead of being
ignored—i.e., capture the error, log a clear message with params.containerID
using log.Infof/log.Errorf as appropriate, and return the error (or wrap it) so
callers receive a failure when writing the result envelope fails.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: bf44724d-13f4-47a6-8020-1897798b8840
📒 Files selected for processing (3)
cmd/root.gocmd/runusercommands.gocmd/runusercommands_test.go
Comment on lines
+91
to
+94
| user := devcconfig.GetRemoteUser(result) | ||
| log.Infof("lifecycle commands completed for container %s", params.containerID) | ||
| _ = devcconfig.WriteResultJSON(os.Stderr, params.containerID, user, params.workdir) | ||
| return nil |
There was a problem hiding this comment.
Handle WriteResultJSON failures instead of discarding them.
If writing the result envelope fails, the command still returns success, which leaves callers with no machine-readable result and masks the real failure.
💡 Suggested fix
- user := devcconfig.GetRemoteUser(result)- log.Infof("lifecycle commands completed for container %s", params.containerID)- _ = devcconfig.WriteResultJSON(os.Stderr, params.containerID, user, params.workdir)- return nil+ user := devcconfig.GetRemoteUser(result)+ log.Infof("lifecycle commands completed for container %s", params.containerID)+ if err := devcconfig.WriteResultJSON(os.Stderr, params.containerID, user, params.workdir); err != nil {+ return err+ }+ return nil📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| user:=devcconfig.GetRemoteUser(result) | |
| log.Infof("lifecycle commands completed for container %s", params.containerID) | |
| _=devcconfig.WriteResultJSON(os.Stderr, params.containerID, user, params.workdir) | |
| returnnil | |
| user:=devcconfig.GetRemoteUser(result) | |
| log.Infof("lifecycle commands completed for container %s", params.containerID) | |
| iferr:=devcconfig.WriteResultJSON(os.Stderr, params.containerID, user, params.workdir); err!=nil { | |
| returnerr | |
| } | |
| returnnil |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cmd/runusercommands.go` around lines 91 - 94, The call to
devcconfig.WriteResultJSON in the end of the command currently discards its
error; change the code in the function containing user :=
devcconfig.GetRemoteUser(result) so that the returned error from
devcconfig.WriteResultJSON(os.Stderr, params.containerID, user, params.workdir)
is checked and propagated (or logged and returned) instead of being
ignored—i.e., capture the error, log a clear message with params.containerID
using log.Infof/log.Errorf as appropriate, and return the error (or wrap it) so
callers receive a failure when writing the result envelope fails.
Comment on lines
+181
to
+184
| if err := params.helper.Run(params.ctx, args, os.Stdin, os.Stdout, os.Stderr); err != nil { | ||
| return fmt.Errorf("command %q failed: %w", key, err) | ||
| } | ||
| } |
There was a problem hiding this comment.
Keep hook stderr separate from the JSON envelope.
execLifecycleHook() forwards each lifecycle command's stderr to os.Stderr, and Run() later writes the result envelope to the same stream. Any hook that emits diagnostics will corrupt the envelope and break parsers downstream.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cmd/runusercommands.go` around lines 181 - 184, The hook's stderr is
currently forwarded to os.Stderr inside execLifecycleHook which mixes
diagnostics with the JSON envelope written later by params.helper.Run; change
execLifecycleHook (and where it's invoked) to capture hook stderr into a
separate io.Writer (e.g., a bytes.Buffer or a dedicated params.hookStderr)
instead of passing os.Stderr, pass that buffer into params.helper.Run
invocations (the call site using params.helper.Run(params.ctx, args, os.Stdin,
os.Stdout, os.Stderr)), and ensure the JSON envelope is written only to
os.Stdout; emit any captured hook stderr to os.Stderr (or into a separate
diagnostics channel/field) outside or before/after the envelope so it cannot
corrupt the JSON output.
Uh oh!
There was an error while loading. Please reload this page.
This was referenced May 4, 2026
This was referenced May 16, 2026
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 freeto 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
Adds a new
run-user-commandsCLI command that connects to an already-running devcontainer and executes lifecycle commands (postCreateCommand, postStartCommand, postAttachCommand) in order. This unblocks CI/CD pipelines that need to trigger lifecycle hooks on existing containers without a fullupcycle.exec.gorunUserCommandscamelCase alias for devcontainer CLI compatibilitySummary by CodeRabbit
New Features
run-user-commandsCLI command to execute Dev Container lifecycle commands (post-create, post-start, post-attach) within running workspace containers, with flexible container targeting through label-based identification.Tests