docs(local-windows-rdp): fix invalid coder_agent.main.name in README examples - #875
Merged
Merged
Conversation
Contributor
Version Bump RequiredOne or more modules in this PR need their versions updated. To fix this:
The CI will automatically re-run once you push the updated versions. |
matifali
approved these changes
Apr 25, 2026
35C4n0r
enabled auto-merge (squash)
July 27, 2026 13:31
Contributor
Module Scorecard Check
|
| Theme | Before | After |
|---|---|---|
| Presentation & Onboarding | 17 / 25 | 17 / 25 |
| Integration | — | — |
| Credential Hygiene | 18 / 20 | 18 / 20 |
| Restricted-Environment | N/A | N/A |
| Engineering Quality | 10 / 10 | 10 / 10 |
| Overall | 82 / 100 | 82 / 100 |
Full scorecard for this PR
| Presentation & Onboarding | Credential Hygiene | Restricted-Environment Readiness | Engineering Quality | Overall |
|---|---|---|---|---|
| 17 / 25 | 18 / 20 | N/A | 10 / 10 | 82 / 100 |
Drilldown
Presentation & Onboarding — 17 / 25
| Criterion | Max | Score | Notes |
|---|---|---|---|
| Configuration-mode examples | 12 | 12 | README provides two clear examples: basic usage with defaults and custom display name configuration. Both are complete and sensible. |
| Coder-context framing | 8 | 5 | README explains what the module does (enables RDP on Windows workspaces, adds one-click button through Coder Desktop) and mentions Coder Desktop requirement. However, it doesn't clearly explain where Coder fits in the broader RDP flow or what value Coder adds beyond standard RDP. |
| Visual preview | 5 | 0 | No image, GIF, or video in README. Only an icon reference in frontmatter. |
Credential Hygiene — 18 / 20
| Criterion | Max | Score | Notes |
|---|---|---|---|
| Secrets marked sensitive | 16 | 16 | The password variable is marked sensitive = true in main.tf. README examples use default values rather than inline placeholder secrets. |
| Non-hardcoded auth path | 4 | 2 | Module requires explicit password configuration. While it has a default, there's no documented path to avoid credential management (like Windows Hello, certificate auth, or external auth provider integration). |
Restricted-Environment Readiness — N/A
| Criterion | Max | Score | Notes |
|---|---|---|---|
| Mirrorable artifact source | 10 | N/A | Module downloads nothing; it only configures Windows RDP services already present in the OS. |
| Bring-your-own binary | 5 | N/A | Module downloads nothing; it configures existing Windows RDP functionality. |
| Egress transparency | 3 | N/A | Module makes no external network calls during install or runtime; it only configures local Windows services. |
| Runs without sudo | 2 | N/A | Module has no scripts to inspect (configure-rdp.ps1 is referenced but not provided in the module files). |
Engineering Quality — 10 / 10
| Criterion | Max | Score | Notes |
|---|---|---|---|
| Input quality | 6 | 6 | All variables have clear descriptions and sensible defaults. The password variable is properly marked sensitive. Variables like order and group have appropriate nullable defaults. |
| Test coverage | 4 | 4 | Comprehensive TypeScript test suite in main.test.ts covers: required variables, default values, custom values, credential handling, URI format construction, and sensitive variable handling. Tests verify both coder_app and coder_script resources. |
Overall — 82 / 100
Raw 45 / 55 → round(45 / 55 × 100) = 82
Track: Utility (RDP configuration tool, not an IDE or AI agent)
Badge: Adequate
Scored against SCORECARD.md with claude-sonnet-4-5. Language-model scores are advisory.
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.
Problem
The README examples for the
local-windows-rdpmodule referencecoder_agent.main.name, but thecoder_agentresource does not export anameattribute (seeprovider/agent.go). Users copying the example from the registry page hit:Fix
Replace
coder_agent.main.namewith the hardcoded string"main"in the two affected examples, matching the convention used in other registry templates (e.g.templates/docker/main.tf). The third example in the README already used a hardcoded string ("windows") correctly.Created on behalf of @ericpaulsen