publicWagsHome/modules
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

feat: add version to module docs (#122)

Browse Source
This commit is contained in:
Muhammad Atif Ali
2024-01-23 13:50:55 +03:00
committed by GitHub
parent 5b3edd9bbd
commit b968a2aa22
26 changed files with 271 additions and 207 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.sample/README.md
View File

@@ -13,7 +13,8 @@ tags: [helper]
```hcl
module "MODULE_NAME" {
source = "https://registry.coder.com/modules/MODULE_NAME"
source = "registry.coder.com/modules/MODULE_NAME/coder"
version = "1.0.0"
}
```
@@ -27,7 +28,8 @@ Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
```hcl
module "MODULE_NAME" {
source = "https://registry.coder.com/modules/MODULE_NAME"
source = "registry.coder.com/modules/MODULE_NAME/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
extensions = [
"dracula-theme.theme-dracula"
@@ -43,7 +45,8 @@ Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarte
```hcl
module "MODULE_NAME" {
source = "https://registry.coder.com/modules/MODULE_NAME"
source = "registry.coder.com/modules/MODULE_NAME/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
extensions = [ "dracula-theme.theme-dracula" ]
settings = {
@@ -58,7 +61,8 @@ Run code-server in the background, don't fetch it from GitHub:
```hcl
module "MODULE_NAME" {
source = "https://registry.coder.com/modules/MODULE_NAME"
source = "registry.coder.com/modules/MODULE_NAME/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
offline = true
}

2
CONTRIBUTING.md
View File

@@ -20,7 +20,9 @@ $ bun test -t '<module>'
You can test a module locally by updating the source as follows
```hcl
module "example" {
source = "git::https://github.com/<USERNAME>/<REPO>.git//<MODULE-NAME>?ref=<BRANCH-NAME>"
}
```
> **Note:** This is the responsibility of the module author to implement tests for their module. and test the module locally before submitting a PR.

3
README.md
View File

@@ -16,7 +16,8 @@ e.g.
```hcl
module "code-server" {
source = "https://registry.coder.com/modules/code-server"
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
agent_id = coder_agent.main.id
}
```

9
aws-region/README.md
View File

@@ -16,7 +16,8 @@ Customize the preselected parameter value:
```hcl
module "aws-region" {
source = "https://registry.coder.com/modules/aws-region"
source = "registry.coder.com/modules/aws-region/coder"
version = "1.0.0"
default = "us-east-1"
}
@@ -35,7 +36,8 @@ Change the display name and icon for a region using the corresponding maps:
```hcl
module "aws-region" {
source = "https://registry.coder.com/modules/aws-region"
source = "registry.coder.com/modules/aws-region/coder"
version = "1.0.0"
default = "ap-south-1"
custom_names = {
"ap-south-1": "Awesome Mumbai!"
@@ -58,7 +60,8 @@ Hide the Asia Pacific regions Seoul and Osaka:
```hcl
module "aws-region" {
source = "https://registry.coder.com/modules/aws-region"
source = "registry.coder.com/modules/aws-region/coder"
version = "1.0.0"
exclude = [ "ap-northeast-2", "ap-northeast-3" ]
}

9
azure-region/README.md
View File

@@ -13,7 +13,8 @@ This module adds a parameter with all Azure regions, allowing developers to sele
```hcl
module "azure_region" {
source = "https://registry.coder.com/modules/azure-region"
source = "registry.coder.com/modules/azure-region/coder"
version = "1.0.0"
default = "eastus"
}
@@ -32,7 +33,8 @@ Change the display name and icon for a region using the corresponding maps:
```hcl
module "azure-region" {
source = "https://registry.coder.com/modules/azure-region"
source = "registry.coder.com/modules/azure-region/coder"
version = "1.0.0"
custom_names = {
"australia": "Go Australia!"
}
@@ -54,7 +56,8 @@ Hide all regions in Australia except australiacentral:
```hcl
module "azure-region" {
source = "https://registry.coder.com/modules/azure-region"
source = "registry.coder.com/modules/azure-region/coder"
version = "1.0.0"
exclude = [
"australia",
"australiacentral2",

18
code-server/README.md
View File

@@ -13,7 +13,8 @@ Automatically install [code-server](https://github.com/coder/code-server) in a w
```hcl
module "code-server" {
source = "https://registry.coder.com/modules/code-server"
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```
@@ -26,7 +27,8 @@ module "code-server" {
```hcl
module "code-server" {
source = "https://registry.coder.com/modules/code-server"
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
install_version = "4.8.3"
}
@@ -38,7 +40,8 @@ Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
```hcl
module "code-server" {
source = "https://registry.coder.com/modules/code-server"
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
extensions = [
"dracula-theme.theme-dracula"
@@ -54,7 +57,8 @@ Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarte
```hcl
module "settings" {
source = "https://registry.coder.com/modules/code-server"
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
extensions = [ "dracula-theme.theme-dracula" ]
settings = {
@@ -69,7 +73,8 @@ Just run code-server in the background, don't fetch it from GitHub:
```hcl
module "settings" {
source = "https://registry.coder.com/modules/code-server"
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
extensions = [ "dracula-theme.theme-dracula", "ms-azuretools.vscode-docker" ]
}
@@ -81,7 +86,8 @@ Just run code-server in the background, don't fetch it from GitHub:
```hcl
module "settings" {
source = "https://registry.coder.com/modules/code-server"
source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
offline = true
}

3
coder-login/README.md
View File

@@ -13,7 +13,8 @@ Automatically logs the user into Coder when creating their workspace.
```hcl
module "coder-login" {
source = "https://registry.coder.com/modules/coder-login"
source = "registry.coder.com/modules/coder-login/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

3
dotfiles/README.md
View File

@@ -13,7 +13,8 @@ Allow developers to optionally bring their own [dotfiles repository](https://dot
```hcl
module "dotfiles" {
source = "https://registry.coder.com/modules/dotfiles"
source = "registry.coder.com/modules/dotfiles/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

9
exoscale-instance-type/README.md
View File

@@ -16,7 +16,8 @@ Customize the preselected parameter value:
```hcl
module "exoscale-instance-type" {
source = "https://registry.coder.com/modules/exoscale-instance-type"
source = "registry.coder.com/modules/exoscale-instance-type/coder"
version = "1.0.0"
default = "standard.medium"
}
@@ -43,7 +44,8 @@ Change the display name a type using the corresponding maps:
```hcl
module "exoscale-instance-type" {
source = "https://registry.coder.com/modules/exoscale-instance-type"
source = "registry.coder.com/modules/exoscale-instance-type/coder"
version = "1.0.0"
default = "standard.medium"
custom_names = {
"standard.medium": "Mittlere Instanz" # German translation
@@ -74,7 +76,8 @@ Show only gpu1 types
```hcl
module "exoscale-instance-type" {
source = "https://registry.coder.com/modules/exoscale-instance-type"
source = "registry.coder.com/modules/exoscale-instance-type/coder"
version = "1.0.0"
default = "gpu.large"
type_category = ["gpu"]
exclude = [

9
exoscale-zone/README.md
View File

@@ -16,7 +16,8 @@ Customize the preselected parameter value:
```hcl
module "exoscale-zone" {
source = "https://registry.coder.com/modules/exoscale-zone"
source = "registry.coder.com/modules/exoscale-zone/coder"
version = "1.0.0"
default = "ch-dk-2"
}
@@ -42,7 +43,8 @@ Change the display name and icon for a zone using the corresponding maps:
```hcl
module "exoscale-zone" {
source = "https://registry.coder.com/modules/exoscale-zone"
source = "registry.coder.com/modules/exoscale-zone/coder"
version = "1.0.0"
default = "at-vie-1"
custom_names = {
"at-vie-1": "Home Vienna"
@@ -71,7 +73,8 @@ Hide the Switzerland zones Geneva and Zurich
```hcl
module "exoscale-zone" {
source = "https://registry.coder.com/modules/exoscale-zone"
source = "registry.coder.com/modules/exoscale-zone/coder"
version = "1.0.0"
exclude = [ "ch-gva-2", "ch-dk-2" ]
}

9
filebrowser/README.md
View File

@@ -13,7 +13,8 @@ A file browser for your workspace.
```hcl
module "filebrowser" {
source = "https://registry.coder.com/modules/filebrowser"
source = "registry.coder.com/modules/filebrowser/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```
@@ -26,7 +27,8 @@ module "filebrowser" {
```hcl
module "filebrowser" {
source = "https://registry.coder.com/modules/filebrowser"
source = "registry.coder.com/modules/filebrowser/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
folder = "/home/coder/project"
}
@@ -36,7 +38,8 @@ module "filebrowser" {
```hcl
module "filebrowser" {
source = "https://registry.coder.com/modules/filebrowser"
source = "registry.coder.com/modules/filebrowser/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
database_path = ".config/filebrowser.db"
}

9
fly-region/README.md
View File

@@ -15,7 +15,8 @@ We can use the simplest format here, only adding a default selection as the `atl
```hcl
module "fly-region" {
source = "https://registry.coder.com/modules/fly-region"
source = "registry.coder.com/modules/fly-region/coder"
version = "1.0.0"
default = "atl"
}
```
@@ -30,7 +31,8 @@ The regions argument can be used to display only the desired regions in the Code
```hcl
module "fly-region" {
source = "https://registry.coder.com/modules/fly-region"
source = "registry.coder.com/modules/fly-region/coder"
version = "1.0.0"
default = "ams"
regions = ["ams", "arn", "atl"]
}
@@ -44,7 +46,8 @@ Set custom icons and names with their respective maps.
```hcl
module "fly-region" {
source = "https://registry.coder.com/modules/fly-region"
source = "registry.coder.com/modules/fly-region/coder"
version = "1.0.0"
default = "ams"
custom_icons = {
"ams" = "/emojis/1f90e.png"

12
gcp-region/README.md
View File

@@ -13,7 +13,8 @@ This module adds Google Cloud Platform regions to your Coder template.
```hcl
module "gcp_region" {
source = "https://registry.coder.com/modules/gcp-region"
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
regions = ["us", "europe"]
}
@@ -32,7 +33,8 @@ Note: setting `gpu_only = true` and using a default region without GPU support,
```hcl
module "gcp_region" {
source = "https://registry.coder.com/modules/gcp-region"
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
default = ["us-west1-a"]
regions = ["us-west1"]
gpu_only = false
@@ -47,7 +49,8 @@ resource "google_compute_instance" "example" {
```hcl
module "gcp_region" {
source = "https://registry.coder.com/modules/gcp-region"
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
regions = ["europe-west"]
single_zone_per_region = false
}
@@ -61,7 +64,8 @@ resource "google_compute_instance" "example" {
```hcl
module "gcp_region" {
source = "https://registry.coder.com/modules/gcp-region"
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
regions = ["us", "europe"]
gpu_only = true
single_zone_per_region = true

6
git-clone/README.md
View File

@@ -13,7 +13,8 @@ This module allows you to automatically clone a repository by URL and skip if it
```hcl
module "git-clone" {
source = "https://registry.coder.com/modules/git-clone"
source = "registry.coder.com/modules/git-clone/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
url = "https://github.com/coder/coder"
}
@@ -33,7 +34,8 @@ data "coder_git_auth" "github" {
```hcl
module "git-clone" {
source = "https://registry.coder.com/modules/git-clone"
source = "registry.coder.com/modules/git-clone/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
url = "https://github.com/coder/coder"
path = "~/projects/coder/coder"

3
git-commit-signing/README.md
View File

@@ -18,7 +18,8 @@ This module has a chance of conflicting with the user's dotfiles / the personali
```hcl
module "git-commit-signing" {
source = "https://registry.coder.com/modules/git-commit-signing"
source = "registry.coder.com/modules/git-commit-signing/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

9
git-config/README.md
View File

@@ -13,7 +13,8 @@ Runs a script that updates git credentials in the workspace to match the user's
```hcl
module "git-config" {
source = "https://registry.coder.com/modules/git-config"
source = "registry.coder.com/modules/git-config/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```
@@ -26,7 +27,8 @@ TODO: Add screenshot
```hcl
module "git-config" {
source = "https://registry.coder.com/modules/git-config"
source = "registry.coder.com/modules/git-config/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
allow_email_change = true
}
@@ -38,7 +40,8 @@ TODO: Add screenshot
```hcl
module "git-config" {
source = "https://registry.coder.com/modules/git-config"
source = "registry.coder.com/modules/git-config/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
allow_username_change = false
allow_email_change = false

6
jetbrains-gateway/README.md
View File

@@ -13,7 +13,8 @@ This module adds a JetBrains Gateway Button to open any workspace with a single
```hcl
module "jetbrains_gateway" {
source = "https://registry.coder.com/modules/jetbrains-gateway"
source = "registry.coder.com/modules/jetbrains-gateway/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
folder = "/home/coder/example"
jetbrains_ides = ["GO", "WS", "IU", "PY", "PS", "CL", "RM"]
@@ -29,7 +30,8 @@ module "jetbrains_gateway" {
```hcl
module "jetbrains_gateway" {
source = "https://registry.coder.com/modules/jetbrains-gateway"
source = "registry.coder.com/modules/jetbrains-gateway/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
folder = "/home/coder/example"
jetbrains_ides = ["GO", "WS"]

9
jfrog-oauth/README.md
View File

@@ -18,7 +18,8 @@ Install the JF CLI and authenticate package managers with Artifactory using OAut
```hcl
module "jfrog" {
source = "https://registry.coder.com/modules/jfrog-oauth"
source = "registry.coder.com/modules/jfrog-oauth/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
jfrog_url = "https://jfrog.example.com"
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
@@ -85,7 +86,8 @@ Configure the Python pip package manager to fetch packages from Artifactory whil
```hcl
module "jfrog" {
source = "https://registry.coder.com/modules/jfrog-oauth"
source = "registry.coder.com/modules/jfrog-oauth/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
jfrog_url = "https://jfrog.example.com"
auth_method = "oauth"
@@ -112,7 +114,8 @@ The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extensio
```hcl
module "jfrog" {
source = "https://registry.coder.com/modules/jfrog-oauth"
source = "registry.coder.com/modules/jfrog-oauth/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
jfrog_url = "https://jfrog.example.com"
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"

9
jfrog-token/README.md
View File

@@ -14,7 +14,8 @@ Install the JF CLI and authenticate package managers with Artifactory using Arti
```hcl
module "jfrog" {
source = "https://registry.coder.com/modules/jfrog-token"
source = "registry.coder.com/modules/jfrog-token/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
jfrog_url = "https://XXXX.jfrog.io"
artifactory_access_token = var.artifactory_access_token
@@ -46,7 +47,8 @@ variable "artifactory_access_token" {
```hcl
module "jfrog" {
source = "https://registry.coder.com/modules/jfrog-token"
source = "registry.coder.com/modules/jfrog-token/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
jfrog_url = "https://YYYY.jfrog.io"
artifactory_access_token = var.artifactory_access_token # An admin access token
@@ -78,7 +80,8 @@ The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extensio
```hcl
module "jfrog" {
source = "https://registry.coder.com/modules/jfrog-token"
source = "registry.coder.com/modules/jfrog-token/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
jfrog_url = "https://XXXX.jfrog.io"
artifactory_access_token = var.artifactory_access_token

3
jupyter-notebook/README.md
View File

@@ -15,7 +15,8 @@ A module that adds Jupyter Notebook in your Coder template.
```hcl
module "jupyter-notebook" {
source = "https://registry.coder.com/modules/jupyter-notebook"
source = "registry.coder.com/modules/jupyter-notebook/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

3
jupyterlab/README.md
View File

@@ -15,7 +15,8 @@ A module that adds JupyterLab in your Coder template.
```hcl
module "jupyterlab" {
source = "https://registry.coder.com/modules/jupyterlab"
source = "registry.coder.com/modules/jupyterlab/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

3
personalize/README.md
View File

@@ -13,7 +13,8 @@ Run a script on workspace start that allows developers to run custom commands to
```hcl
module "personalize" {
source = "https://registry.coder.com/modules/personalize"
source = "registry.coder.com/modules/personalize/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```

8
slackme/README.md
View File

@@ -12,7 +12,7 @@ tags: [helper]
Add the `slackme` command to your workspace that DMs you on Slack when your command finishes running.
```bash
$ slackme npm run long-build
slackme npm run long-build
```
## Setup
@@ -56,7 +56,8 @@ $ slackme npm run long-build
```hcl
module "slackme" {
source = "https://registry.coder.com/modules/slackme"
source = "registry.coder.com/modules/slackme/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
auth_provider_id = "slack"
}
@@ -71,7 +72,8 @@ $ slackme npm run long-build
```hcl
module "slackme" {
source = "https://registry.coder.com/modules/slackme"
source = "registry.coder.com/modules/slackme/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
auth_provider_id = "slack"
slack_message = <<EOF

12
vault-github/README.md
View File

@@ -13,7 +13,8 @@ This module lets you authenticate with [Hashicorp Vault](https://www.vaultprojec
```hcl
module "vault" {
source = "https://registry.coder.com/modules/vault-github"
source = "registry.coder.com/modules/vault-github/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
}
@@ -43,7 +44,8 @@ To configure the Vault module, you must set up a Vault GitHub auth method. See t
```hcl
module "vault" {
source = "https://registry.coder.com/modules/vault"
source = "registry.coder.com/modules/vault-github/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
coder_github_auth_id = "my-github-auth-id"
@@ -54,7 +56,8 @@ module "vault" {
```hcl
module "vault" {
source = "https://registry.coder.com/modules/vault"
source = "registry.coder.com/modules/vault-github/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
coder_github_auth_id = "my-github-auth-id"
@@ -66,7 +69,8 @@ module "vault" {
```hcl
module "vault" {
source = "https://registry.coder.com/modules/vault"
source = "registry.coder.com/modules/vault-github/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
vault_addr = "https://vault.example.com"
vault_cli_version = "1.15.0"

6
vscode-desktop/README.md
View File

@@ -15,7 +15,8 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder)
```hcl
module "vscode" {
source = "https://registry.coder.com/modules/vscode-desktop"
source = "registry.coder.com/modules/vscode-desktop/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
}
```
@@ -26,7 +27,8 @@ module "vscode" {
```hcl
module "vscode" {
source = "https://registry.coder.com/modules/vscode-desktop"
source = "registry.coder.com/modules/vscode-desktop/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
folder = "/home/coder/project"
}

6
vscode-web/README.md
View File

@@ -13,7 +13,8 @@ Automatically install [Visual Studio Code Server](https://code.visualstudio.com/
```hcl
module "vscode-web" {
source = "https://registry.coder.com/modules/vscode-web"
source = "registry.coder.com/modules/vscode-web/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
accept_license = true
}
@@ -27,7 +28,8 @@ module "vscode-web" {
```hcl
module "vscode-web" {
source = "https://registry.coder.com/modules/vscode-web"
source = "registry.coder.com/modules/vscode-web/coder"
version = "1.0.0"
agent_id = coder_agent.example.id
install_dir = "/home/coder/.vscode-web"
folder = "/home/coder"