Skip to content

feat(dotfiles): add custom variable for the dotfiles parameter description #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 9, 2025
Merged

feat(dotfiles): add custom variable for the dotfiles parameter description #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9b4df49
feat(dotfiles): add custom variable for the dotfiles parameter descri…
diranged Jun 13, 2025
bbe44f6
Merge branch 'main' into matt/dotfiles-description
DevelopmentCats Jun 16, 2025
650c95f
Merge branch 'main' into matt/dotfiles-description
DevelopmentCats Jun 17, 2025
6efb1d6
Merge branch 'main' into matt/dotfiles-description
DevelopmentCats Jul 9, 2025
f0db2c6
Merge branch 'main' into matt/dotfiles-description
DevelopmentCats Jul 9, 2025
0cf601d
chore(dotfiles): update module version to 1.2.0 in README.md for mino…
DevelopmentCats Jul 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions registry/coder/modules/dotfiles/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Under the hood, this module uses the [coder dotfiles](https://coder.com/docs/v2/
module "dotfiles" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/dotfiles/coder"
version = "1.1.0"
version = "1.2.0"
agent_id = coder_agent.example.id
}
```
Expand All @@ -32,7 +32,7 @@ module "dotfiles" {
module "dotfiles" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/dotfiles/coder"
version = "1.1.0"
version = "1.2.0"
agent_id = coder_agent.example.id
}
```
Expand All @@ -43,7 +43,7 @@ module "dotfiles" {
module "dotfiles" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/dotfiles/coder"
version = "1.1.0"
version = "1.2.0"
agent_id = coder_agent.example.id
user = "root"
}
Expand All @@ -55,14 +55,14 @@ module "dotfiles" {
module "dotfiles" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/dotfiles/coder"
version = "1.1.0"
version = "1.2.0"
agent_id = coder_agent.example.id
}

module "dotfiles-root" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/dotfiles/coder"
version = "1.1.0"
version = "1.2.0"
agent_id = coder_agent.example.id
user = "root"
dotfiles_uri = module.dotfiles.dotfiles_uri
Expand All @@ -77,7 +77,7 @@ You can set a default dotfiles repository for all users by setting the `default_
module "dotfiles" {
count = data.coder_workspace.me.start_count
source = "registry.coder.com/coder/dotfiles/coder"
version = "1.1.0"
version = "1.2.0"
agent_id = coder_agent.example.id
default_dotfiles_uri = "https://github.com/coder/dotfiles"
}
Expand Down
8 changes: 7 additions & 1 deletion registry/coder/modules/dotfiles/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ variable "agent_id" {
description = "The ID of a Coder agent."
}

variable "description" {
type = string
description = "A custom description for the dotfiles parameter. This is shown in the UI - and allows you to customize the instructions you give to your users."
default = "Enter a URL for a [dotfiles repository](https://dotfiles.github.io) to personalize your workspace"
}

variable "default_dotfiles_uri" {
type = string
description = "The default dotfiles URI if the workspace user does not provide one"
Expand Down Expand Up @@ -64,7 +70,7 @@ data "coder_parameter" "dotfiles_uri" {
display_name = "Dotfiles URL"
order = var.coder_parameter_order
default = var.default_dotfiles_uri
description = "Enter a URL for a [dotfiles repository](https://dotfiles.github.io) to personalize your workspace"
description = var.description
mutable = true
icon = "/icon/dotfiles.svg"
}
Expand Down