From b968a2aa22cbcbc4a066c64caf5c908c8c621fed Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Tue, 23 Jan 2024 13:50:55 +0300 Subject: [PATCH] feat: add version to module docs (#122) --- .sample/README.md | 34 ++++++++++++---------- CONTRIBUTING.md | 4 ++- README.md | 5 ++-- aws-region/README.md | 33 +++++++++++---------- azure-region/README.md | 41 +++++++++++++------------- code-server/README.md | 46 +++++++++++++++++------------- coder-login/README.md | 5 ++-- dotfiles/README.md | 3 +- exoscale-instance-type/README.md | 49 +++++++++++++++++--------------- exoscale-zone/README.md | 27 ++++++++++-------- filebrowser/README.md | 19 +++++++------ fly-region/README.md | 29 ++++++++++--------- gcp-region/README.md | 38 ++++++++++++++----------- git-clone/README.md | 18 ++++++------ git-commit-signing/README.md | 5 ++-- git-config/README.md | 9 ++++-- jetbrains-gateway/README.md | 6 ++-- jfrog-oauth/README.md | 29 ++++++++++--------- jfrog-token/README.md | 9 ++++-- jupyter-notebook/README.md | 5 ++-- jupyterlab/README.md | 5 ++-- personalize/README.md | 3 +- slackme/README.md | 8 ++++-- vault-github/README.md | 36 ++++++++++++----------- vscode-desktop/README.md | 6 ++-- vscode-web/README.md | 6 ++-- 26 files changed, 271 insertions(+), 207 deletions(-) diff --git a/.sample/README.md b/.sample/README.md index 387d45b..f50a101 100644 --- a/.sample/README.md +++ b/.sample/README.md @@ -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,11 +28,12 @@ Install the Dracula theme from [OpenVSX](https://open-vsx.org/): ```hcl module "MODULE_NAME" { - source = "https://registry.coder.com/modules/MODULE_NAME" - agent_id = coder_agent.example.id - extensions = [ - "dracula-theme.theme-dracula" - ] + source = "registry.coder.com/modules/MODULE_NAME/coder" + version = "1.0.0" + agent_id = coder_agent.example.id + extensions = [ + "dracula-theme.theme-dracula" + ] } ``` @@ -43,12 +45,13 @@ Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarte ```hcl module "MODULE_NAME" { - source = "https://registry.coder.com/modules/MODULE_NAME" - agent_id = coder_agent.example.id - extensions = [ "dracula-theme.theme-dracula" ] - settings = { - "workbench.colorTheme" = "Dracula" - } + source = "registry.coder.com/modules/MODULE_NAME/coder" + version = "1.0.0" + agent_id = coder_agent.example.id + extensions = [ "dracula-theme.theme-dracula" ] + settings = { + "workbench.colorTheme" = "Dracula" + } } ``` @@ -58,8 +61,9 @@ Run code-server in the background, don't fetch it from GitHub: ```hcl module "MODULE_NAME" { - source = "https://registry.coder.com/modules/MODULE_NAME" - agent_id = coder_agent.example.id - offline = true + source = "registry.coder.com/modules/MODULE_NAME/coder" + version = "1.0.0" + agent_id = coder_agent.example.id + offline = true } ``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c3efdc..b45c1f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,9 @@ $ bun test -t '' You can test a module locally by updating the source as follows ```hcl -source = "git::https://github.com//.git//?ref=" +module "example" { + source = "git::https://github.com//.git//?ref=" +} ``` > **Note:** This is the responsibility of the module author to implement tests for their module. and test the module locally before submitting a PR. diff --git a/README.md b/README.md index b01b24d..522477b 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,9 @@ e.g. ```hcl module "code-server" { - source = "https://registry.coder.com/modules/code-server" - agent_id = coder_agent.main.id + source = "registry.coder.com/modules/code-server/coder" + version = "1.0.0" + agent_id = coder_agent.main.id } ``` diff --git a/aws-region/README.md b/aws-region/README.md index 02a731a..824d7d9 100644 --- a/aws-region/README.md +++ b/aws-region/README.md @@ -16,12 +16,13 @@ Customize the preselected parameter value: ```hcl module "aws-region" { - source = "https://registry.coder.com/modules/aws-region" - default = "us-east-1" + source = "registry.coder.com/modules/aws-region/coder" + version = "1.0.0" + default = "us-east-1" } provider "aws" { - region = module.aws_region.value + region = module.aws_region.value } ``` @@ -35,18 +36,19 @@ 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" - default = "ap-south-1" - custom_names = { - "ap-south-1": "Awesome Mumbai!" - } - custom_icons = { - "ap-south-1": "/emojis/1f33a.png" - } + source = "registry.coder.com/modules/aws-region/coder" + version = "1.0.0" + default = "ap-south-1" + custom_names = { + "ap-south-1": "Awesome Mumbai!" + } + custom_icons = { + "ap-south-1": "/emojis/1f33a.png" + } } provider "aws" { - region = module.aws_region.value + region = module.aws_region.value } ``` @@ -58,12 +60,13 @@ Hide the Asia Pacific regions Seoul and Osaka: ```hcl module "aws-region" { - source = "https://registry.coder.com/modules/aws-region" - exclude = [ "ap-northeast-2", "ap-northeast-3" ] + source = "registry.coder.com/modules/aws-region/coder" + version = "1.0.0" + exclude = [ "ap-northeast-2", "ap-northeast-3" ] } provider "aws" { - region = module.aws_region.value + region = module.aws_region.value } ``` diff --git a/azure-region/README.md b/azure-region/README.md index a6a0b7c..b22dedf 100644 --- a/azure-region/README.md +++ b/azure-region/README.md @@ -13,12 +13,13 @@ 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" - default = "eastus" + source = "registry.coder.com/modules/azure-region/coder" + version = "1.0.0" + default = "eastus" } resource "azurem_resource_group" "example" { - location = module.azure_region.value + location = module.azure_region.value } ``` @@ -32,17 +33,18 @@ 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" - custom_names = { - "australia": "Go Australia!" - } - custom_icons = { - "australia": "/icons/smiley.svg" - } + source = "registry.coder.com/modules/azure-region/coder" + version = "1.0.0" + custom_names = { + "australia": "Go Australia!" + } + custom_icons = { + "australia": "/icons/smiley.svg" + } } resource "azurerm_resource_group" "example" { - location = module.azure_region.value + location = module.azure_region.value } ``` @@ -54,17 +56,18 @@ Hide all regions in Australia except australiacentral: ```hcl module "azure-region" { - source = "https://registry.coder.com/modules/azure-region" - exclude = [ - "australia", - "australiacentral2", - "australiaeast", - "australiasoutheast" - ] + source = "registry.coder.com/modules/azure-region/coder" + version = "1.0.0" + exclude = [ + "australia", + "australiacentral2", + "australiaeast", + "australiasoutheast" + ] } resource "azurerm_resource_group" "example" { - location = module.azure_region.value + location = module.azure_region.value } ``` diff --git a/code-server/README.md b/code-server/README.md index ca076df..9bc0417 100644 --- a/code-server/README.md +++ b/code-server/README.md @@ -13,8 +13,9 @@ 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" - agent_id = coder_agent.example.id + 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,11 +40,12 @@ Install the Dracula theme from [OpenVSX](https://open-vsx.org/): ```hcl module "code-server" { - source = "https://registry.coder.com/modules/code-server" - agent_id = coder_agent.example.id - extensions = [ - "dracula-theme.theme-dracula" - ] + source = "registry.coder.com/modules/code-server/coder" + version = "1.0.0" + agent_id = coder_agent.example.id + extensions = [ + "dracula-theme.theme-dracula" + ] } ``` @@ -54,12 +57,13 @@ Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarte ```hcl module "settings" { - source = "https://registry.coder.com/modules/code-server" - agent_id = coder_agent.example.id - extensions = [ "dracula-theme.theme-dracula" ] - settings = { - "workbench.colorTheme" = "Dracula" - } + source = "registry.coder.com/modules/code-server/coder" + version = "1.0.0" + agent_id = coder_agent.example.id + extensions = [ "dracula-theme.theme-dracula" ] + settings = { + "workbench.colorTheme" = "Dracula" + } } ``` @@ -69,9 +73,10 @@ Just run code-server in the background, don't fetch it from GitHub: ```hcl module "settings" { - source = "https://registry.coder.com/modules/code-server" - agent_id = coder_agent.example.id - extensions = [ "dracula-theme.theme-dracula", "ms-azuretools.vscode-docker" ] + 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,8 +86,9 @@ Just run code-server in the background, don't fetch it from GitHub: ```hcl module "settings" { - source = "https://registry.coder.com/modules/code-server" - agent_id = coder_agent.example.id - offline = true + source = "registry.coder.com/modules/code-server/coder" + version = "1.0.0" + agent_id = coder_agent.example.id + offline = true } ``` diff --git a/coder-login/README.md b/coder-login/README.md index 46b2b47..0c5f8d9 100644 --- a/coder-login/README.md +++ b/coder-login/README.md @@ -13,8 +13,9 @@ Automatically logs the user into Coder when creating their workspace. ```hcl module "coder-login" { - source = "https://registry.coder.com/modules/coder-login" - agent_id = coder_agent.example.id + source = "registry.coder.com/modules/coder-login/coder" + version = "1.0.0" + agent_id = coder_agent.example.id } ``` diff --git a/dotfiles/README.md b/dotfiles/README.md index 316773c..1383c09 100644 --- a/dotfiles/README.md +++ b/dotfiles/README.md @@ -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 } ``` diff --git a/exoscale-instance-type/README.md b/exoscale-instance-type/README.md index e1031e4..4868c9f 100644 --- a/exoscale-instance-type/README.md +++ b/exoscale-instance-type/README.md @@ -16,8 +16,9 @@ Customize the preselected parameter value: ```hcl module "exoscale-instance-type" { - source = "https://registry.coder.com/modules/exoscale-instance-type" - default = "standard.medium" + source = "registry.coder.com/modules/exoscale-instance-type/coder" + version = "1.0.0" + default = "standard.medium" } resource "exoscale_compute_instance" "instance" { @@ -43,14 +44,15 @@ Change the display name a type using the corresponding maps: ```hcl module "exoscale-instance-type" { - source = "https://registry.coder.com/modules/exoscale-instance-type" - default = "standard.medium" - custom_names = { - "standard.medium": "Mittlere Instanz" # German translation - } - custom_descriptions = { - "standard.medium": "4 GB Arbeitsspeicher, 2 Kerne, 10 - 400 GB Festplatte" # German translation - } + source = "registry.coder.com/modules/exoscale-instance-type/coder" + version = "1.0.0" + default = "standard.medium" + custom_names = { + "standard.medium": "Mittlere Instanz" # German translation + } + custom_descriptions = { + "standard.medium": "4 GB Arbeitsspeicher, 2 Kerne, 10 - 400 GB Festplatte" # German translation + } } resource "exoscale_compute_instance" "instance" { @@ -74,19 +76,20 @@ Show only gpu1 types ```hcl module "exoscale-instance-type" { - source = "https://registry.coder.com/modules/exoscale-instance-type" - default = "gpu.large" - type_category = ["gpu"] - exclude = [ - "gpu2.small", - "gpu2.medium", - "gpu2.large", - "gpu2.huge", - "gpu3.small", - "gpu3.medium", - "gpu3.large", - "gpu3.huge" - ] + source = "registry.coder.com/modules/exoscale-instance-type/coder" + version = "1.0.0" + default = "gpu.large" + type_category = ["gpu"] + exclude = [ + "gpu2.small", + "gpu2.medium", + "gpu2.large", + "gpu2.huge", + "gpu3.small", + "gpu3.medium", + "gpu3.large", + "gpu3.huge" + ] } resource "exoscale_compute_instance" "instance" { diff --git a/exoscale-zone/README.md b/exoscale-zone/README.md index 91097c8..360c54b 100644 --- a/exoscale-zone/README.md +++ b/exoscale-zone/README.md @@ -16,8 +16,9 @@ Customize the preselected parameter value: ```hcl module "exoscale-zone" { - source = "https://registry.coder.com/modules/exoscale-zone" - default = "ch-dk-2" + source = "registry.coder.com/modules/exoscale-zone/coder" + version = "1.0.0" + default = "ch-dk-2" } @@ -42,14 +43,15 @@ 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" - default = "at-vie-1" - custom_names = { - "at-vie-1": "Home Vienna" - } - custom_icons = { - "at-vie-1": "/emojis/1f3e0.png" - } + source = "registry.coder.com/modules/exoscale-zone/coder" + version = "1.0.0" + default = "at-vie-1" + custom_names = { + "at-vie-1": "Home Vienna" + } + custom_icons = { + "at-vie-1": "/emojis/1f3e0.png" + } } data "exoscale_compute_template" "my_template" { @@ -71,8 +73,9 @@ Hide the Switzerland zones Geneva and Zurich ```hcl module "exoscale-zone" { - source = "https://registry.coder.com/modules/exoscale-zone" - exclude = [ "ch-gva-2", "ch-dk-2" ] + source = "registry.coder.com/modules/exoscale-zone/coder" + version = "1.0.0" + exclude = [ "ch-gva-2", "ch-dk-2" ] } data "exoscale_compute_template" "my_template" { diff --git a/filebrowser/README.md b/filebrowser/README.md index 134eb52..bde76f6 100644 --- a/filebrowser/README.md +++ b/filebrowser/README.md @@ -13,8 +13,9 @@ A file browser for your workspace. ```hcl module "filebrowser" { - source = "https://registry.coder.com/modules/filebrowser" - agent_id = coder_agent.example.id + source = "registry.coder.com/modules/filebrowser/coder" + version = "1.0.0" + agent_id = coder_agent.example.id } ``` @@ -26,9 +27,10 @@ module "filebrowser" { ```hcl module "filebrowser" { - source = "https://registry.coder.com/modules/filebrowser" - agent_id = coder_agent.example.id - folder = "/home/coder/project" + source = "registry.coder.com/modules/filebrowser/coder" + version = "1.0.0" + agent_id = coder_agent.example.id + folder = "/home/coder/project" } ``` @@ -36,8 +38,9 @@ module "filebrowser" { ```hcl module "filebrowser" { - source = "https://registry.coder.com/modules/filebrowser" - agent_id = coder_agent.example.id - database_path = ".config/filebrowser.db" + source = "registry.coder.com/modules/filebrowser/coder" + version = "1.0.0" + agent_id = coder_agent.example.id + database_path = ".config/filebrowser.db" } ``` diff --git a/fly-region/README.md b/fly-region/README.md index cea64f3..7e5040f 100644 --- a/fly-region/README.md +++ b/fly-region/README.md @@ -15,8 +15,9 @@ 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" - default = "atl" + source = "registry.coder.com/modules/fly-region/coder" + version = "1.0.0" + default = "atl" } ``` @@ -30,9 +31,10 @@ 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" - default = "ams" - regions = ["ams", "arn", "atl"] + source = "registry.coder.com/modules/fly-region/coder" + version = "1.0.0" + default = "ams" + regions = ["ams", "arn", "atl"] } ``` @@ -44,14 +46,15 @@ Set custom icons and names with their respective maps. ```hcl module "fly-region" { - source = "https://registry.coder.com/modules/fly-region" - default = "ams" - custom_icons = { - "ams" = "/emojis/1f90e.png" - } - custom_names = { - "ams" = "We love the Netherlands!" - } + source = "registry.coder.com/modules/fly-region/coder" + version = "1.0.0" + default = "ams" + custom_icons = { + "ams" = "/emojis/1f90e.png" + } + custom_names = { + "ams" = "We love the Netherlands!" + } } ``` diff --git a/gcp-region/README.md b/gcp-region/README.md index ab5daf3..a78ed41 100644 --- a/gcp-region/README.md +++ b/gcp-region/README.md @@ -13,12 +13,13 @@ This module adds Google Cloud Platform regions to your Coder template. ```hcl module "gcp_region" { - source = "https://registry.coder.com/modules/gcp-region" - regions = ["us", "europe"] + source = "registry.coder.com/modules/gcp-region/coder" + version = "1.0.0" + regions = ["us", "europe"] } resource "google_compute_instance" "example" { - zone = module.gcp_region.value + zone = module.gcp_region.value } ``` @@ -32,14 +33,15 @@ 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" - default = ["us-west1-a"] - regions = ["us-west1"] - gpu_only = false + source = "registry.coder.com/modules/gcp-region/coder" + version = "1.0.0" + default = ["us-west1-a"] + regions = ["us-west1"] + gpu_only = false } resource "google_compute_instance" "example" { - zone = module.gcp_region.value + zone = module.gcp_region.value } ``` @@ -47,13 +49,14 @@ resource "google_compute_instance" "example" { ```hcl module "gcp_region" { - source = "https://registry.coder.com/modules/gcp-region" - regions = ["europe-west"] - single_zone_per_region = false + source = "registry.coder.com/modules/gcp-region/coder" + version = "1.0.0" + regions = ["europe-west"] + single_zone_per_region = false } resource "google_compute_instance" "example" { - zone = module.gcp_region.value + zone = module.gcp_region.value } ``` @@ -61,13 +64,14 @@ resource "google_compute_instance" "example" { ```hcl module "gcp_region" { - source = "https://registry.coder.com/modules/gcp-region" - regions = ["us", "europe"] - gpu_only = true - single_zone_per_region = true + source = "registry.coder.com/modules/gcp-region/coder" + version = "1.0.0" + regions = ["us", "europe"] + gpu_only = true + single_zone_per_region = true } resource "google_compute_instance" "example" { - zone = module.gcp_region.value + zone = module.gcp_region.value } ``` diff --git a/git-clone/README.md b/git-clone/README.md index 53e566b..db4ce5f 100644 --- a/git-clone/README.md +++ b/git-clone/README.md @@ -13,9 +13,10 @@ 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" - agent_id = coder_agent.example.id - url = "https://github.com/coder/coder" + source = "registry.coder.com/modules/git-clone/coder" + version = "1.0.0" + agent_id = coder_agent.example.id + url = "https://github.com/coder/coder" } ``` @@ -23,7 +24,7 @@ To use with [Git Authentication](https://coder.com/docs/v2/latest/admin/git-prov ```hcl data "coder_git_auth" "github" { - id = "github" + id = "github" } ``` @@ -33,9 +34,10 @@ data "coder_git_auth" "github" { ```hcl module "git-clone" { - source = "https://registry.coder.com/modules/git-clone" - agent_id = coder_agent.example.id - url = "https://github.com/coder/coder" - path = "~/projects/coder/coder" + 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" } ``` diff --git a/git-commit-signing/README.md b/git-commit-signing/README.md index 38a02c0..c13e1f8 100644 --- a/git-commit-signing/README.md +++ b/git-commit-signing/README.md @@ -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" - agent_id = coder_agent.example.id + source = "registry.coder.com/modules/git-commit-signing/coder" + version = "1.0.0" + agent_id = coder_agent.example.id } ``` diff --git a/git-config/README.md b/git-config/README.md index 1666374..6c9d696 100644 --- a/git-config/README.md +++ b/git-config/README.md @@ -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 diff --git a/jetbrains-gateway/README.md b/jetbrains-gateway/README.md index a48765b..c6c473d 100644 --- a/jetbrains-gateway/README.md +++ b/jetbrains-gateway/README.md @@ -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"] diff --git a/jfrog-oauth/README.md b/jfrog-oauth/README.md index f6aeefa..f81d837 100644 --- a/jfrog-oauth/README.md +++ b/jfrog-oauth/README.md @@ -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" @@ -45,17 +46,17 @@ To set this up, artifactory: enabled: true frontend: - extraEnvironmentVariables: - - name: JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION - value: "true" + extraEnvironmentVariables: + - name: JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION + value: "true" access: - accessConfig: - integrations-enabled: true - integration-templates: - - id: "1" - name: "CODER" - redirect-uri: "https://CODER_URL/external-auth/jfrog/callback" - scope: "applied-permissions/user" + accessConfig: + integrations-enabled: true + integration-templates: + - id: "1" + name: "CODER" + redirect-uri: "https://CODER_URL/external-auth/jfrog/callback" + scope: "applied-permissions/user" ``` > Note @@ -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" diff --git a/jfrog-token/README.md b/jfrog-token/README.md index 94a7ff9..2cba7ad 100644 --- a/jfrog-token/README.md +++ b/jfrog-token/README.md @@ -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 diff --git a/jupyter-notebook/README.md b/jupyter-notebook/README.md index f3730b6..69b6176 100644 --- a/jupyter-notebook/README.md +++ b/jupyter-notebook/README.md @@ -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" - agent_id = coder_agent.example.id + source = "registry.coder.com/modules/jupyter-notebook/coder" + version = "1.0.0" + agent_id = coder_agent.example.id } ``` diff --git a/jupyterlab/README.md b/jupyterlab/README.md index 0953737..8984da2 100644 --- a/jupyterlab/README.md +++ b/jupyterlab/README.md @@ -15,7 +15,8 @@ A module that adds JupyterLab in your Coder template. ```hcl module "jupyterlab" { - source = "https://registry.coder.com/modules/jupyterlab" - agent_id = coder_agent.example.id + source = "registry.coder.com/modules/jupyterlab/coder" + version = "1.0.0" + agent_id = coder_agent.example.id } ``` diff --git a/personalize/README.md b/personalize/README.md index 91a3633..4ddb036 100644 --- a/personalize/README.md +++ b/personalize/README.md @@ -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 } ``` diff --git a/slackme/README.md b/slackme/README.md index 017f06a..28b1f6a 100644 --- a/slackme/README.md +++ b/slackme/README.md @@ -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 = <