Conversation
The coder_agent.dir plan/apply-time warning claimed that setting dir to a value other than $HOME breaks Coder Desktop file sync. That is no longer accurate now that the Mutagen fix (coder/mutagen#10) is released and bundled into the macOS and Windows Desktop clients, which resolve the agent's absolute home directory and use it for both the scp copy and the ssh exec. Remove the file-sync sentence from WarnDirNotHome and from the dir field description, and regenerate docs. The dir deprecation itself is unchanged and still steers users to $HOME, so no min-version/adoption gate is needed. Tracked in DESK-2. Opened by Coder Agents on behalf of @aqandrew.
jeremyruppel
approved these changes
Sep 25, 2026
matifali
requested changes
Sep 26, 2026
| "\n\n~> **Warning:** This attribute is deprecated and will be removed in a future release. " + | ||
| "Setting `dir` to a value other than `$HOME` will break " + | ||
| "[Coder Desktop file sync](https://coder.com/docs/user-guides/desktop/desktop-connect-sync).", | ||
| "\n\n~> **Warning:** This attribute is deprecated and will be removed in a future release.", |
Member
There was a problem hiding this comment.
Are we not deciding that this no undeprecated and will not be removed?
| return nil, nil | ||
| } | ||
| return []string{ | ||
| `"dir" is deprecated and will be removed in a future release.`, |
Member
There was a problem hiding this comment.
same here are we not undeprecating this?
With the current chnage it looks like we are only chnaging the wording but provider wll still show a warning.
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.
Summary
Removes the
coder_agent.dirplan/apply-time warning claim that settingdirto a value other than$HOME"will break Coder Desktop file sync." That claim is no longer accurate now that the Mutagen fix (coder/mutagen#10) is released and bundled into the macOS and Windows Coder Desktop clients. The fix resolves the agent's absolute remote home directory once and uses it for both thescpcopy and thesshexec, so agent installation no longer fails when the remote working directory differs from$HOME.The
dirdeprecation is intentionally left in place — it still steers users to$HOME(or omittingdir), which is the safe configuration.Tracked in DESK-2.
Changes
provider/helpers/validation.go— drop the file-sync sentence fromWarnDirNotHome(and its doc comment). It now returns only the deprecation warning.provider/agent.go— remove the file-sync warning + link from thedirfield description.provider/helpers/validation_test.go—TestWarnDirNotHomeexpected warning count 2 → 1.docs/resources/agent.md— regenerated viamake gen.Why no min-version / adoption gate
The warning fires at
terraform plan/applytime and cannot know which Coder Desktop / Mutagen version each end user runs. Removing it is safe anyway because the survivingdirdeprecation warning already directs users to$HOME, so users on pre-fix clients are not newly exposed (the actionable guidance is unchanged), while users on fixed clients stop seeing a now-false claim.Out of scope
dirdeprecation itself (separate deprecation-cleanup effort).coder/coder docs/install/releases/esr-2.29-2.34-upgrade.mdrepeats the claim but is a version-scoped historical migration note for the 2.29–2.34 ESR window; intentionally left unchanged.Testing
go test ./provider/helpers/...passes.go build ./...passes.make gendiff limited to the removed warning clause.Implementation plan
DESK-2: Remove the "dir breaks Coder Desktop file sync" warning
Remove the now-inaccurate "breaks Coder Desktop file sync" claim from the
coder_agent.dirwarning, now that coder/mutagen#10 is merged, released, and bundled into both Desktop clients. Keep thedirdeprecation itself intact.Inventory of affected locations
terraform-provider-coder
provider/helpers/validation.go—WarnDirNotHomereturned string + doc comment.provider/agent.go—dirfieldDescriptionwarning + link.provider/helpers/validation_test.go—TestWarnDirNotHomewarn count 2 → 1.docs/resources/agent.md— generated~> **Warning:**block (regenerate viamake gen).coder/coder (docs)
docs/user-guides/desktop/desktop-connect-sync.md— only the link target; contains no "dir breaks file sync" wording, so no change.docs/install/releases/esr-2.29-2.34-upgrade.md— repeats the claim in a version-scoped migration table for the 2.29–2.34 ESR window; left as historical.Non-actionable
coder/tss/docs/dogfood/evidence/*.json— captured log output, not source.Design decision
After removing the file-sync sentence,
WarnDirNotHomereturns only the deprecation sentence (which overlaps the schema's SDKDeprecated:field). Kept minimal here; retiring the function/field belongs to the separatedirdeprecation cleanup.Version skew: no adoption gate needed
The warning fires at plan/apply time and cannot know the end user's client version. Remove now; the surviving deprecation warning already steers users to
$HOME, so old-client users are not newly exposed and fixed-client users stop seeing a false claim.🤖 Opened by Coder Agents on behalf of @aqandrew.