NotificationsYou must be signed in to change notification settings
Fork927
Star10.1k

Commit3379347

committed

docs(modules): linting

1 parentba1bba3 commit3379347Copy full SHA for 3379347

File tree

1 file changed

+19

-1

lines changed

docs/about/contributing
- modules.md

1 file changed

+19

-1

lines changed

`‎docs/about/contributing/modules.md`

Lines changed: 19 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ Browse available modules at [registry.coder.com](https://registry.coder.com).`
`110`	`110`
`111`	`111`	`Every module consists of exactly four files:`
`112`	`112`
`113`		-```
	`113`	+```text
`114`	`114`	`module-name/`
`115`	`115`	`├── main.tf # Terraform configuration with Coder resources`
`116`	`116`	`├── main.test.ts # Test suite`
`@@ -136,12 +136,14 @@ The Coder Terraform provider offers several resource types for different aspects`
`136`	`136`	`Execute commands during workspace lifecycle events. This is the primary mechanism for software installation, service configuration, and environment setup.`
`137`	`137`
`138`	`138`	`When to use:`
	`139`	`+`
`139`	`140`	`- Installing software packages, binaries, or development tools`
`140`	`141`	`- Configuring services and generating configuration files`
`141`	`142`	`- Setting up directories, permissions, and initial workspace state`
`142`	`143`	`- Running background services or daemons`
`143`	`144`
`144`	`145`	`Key properties:`
	`146`	`+`
`145`	`147`	-`agent_id`: The Coder agent to execute the script on
`146`	`148`	-`display_name`: Name shown in the Coder dashboard during execution
`147`	`149`	-`run_on_start`: Execute when workspace starts (most common)
`@@ -150,6 +152,7 @@ Execute commands during workspace lifecycle events. This is the primary mechanis`
`150`	`152`	-`start_blocks_login`: Whether script completion is required before user access
`151`	`153`
`152`	`154`	`Example:`
	`155`	`+`
`153`	`156`	```tf
`154`	`157`	`resource "coder_script" "install" {`
`155`	`158`	`agent_id = var.agent_id`
`@@ -168,18 +171,21 @@ resource "coder_script" "install" {`
`168`	`171`	`Create accessible applications in the Coder workspace interface, providing users with one-click access to tools and services.`
`169`	`172`
`170`	`173`	`When to use:`
	`174`	`+`
`171`	`175`	`- Exposing web-based development tools (IDEs, dashboards)`
`172`	`176`	`- Creating links to desktop applications via custom protocols`
`173`	`177`	`- Providing access to running services`
`174`	`178`
`175`	`179`	`Key properties:`
	`180`	`+`
`176`	`181`	-`agent_id`: The Coder agent
`177`	`182`	-`external`:`true` for protocol handlers,`false` for web apps
`178`	`183`	-`healthcheck`: Monitor service availability
`179`	`184`	-`subdomain`: Access method for web apps
`180`	`185`	-`url`: Service URL or protocol handler
`181`	`186`
`182`	`187`	`Example:`
	`188`	`+`
`183`	`189`	```tf
`184`	`190`	`resource "coder_app" "service" {`
`185`	`191`	`agent_id = var.agent_id`
`@@ -199,11 +205,13 @@ resource "coder_app" "service" {`
`199`	`205`	`Set environment variables in workspace sessions for tool configuration and authentication.`
`200`	`206`
`201`	`207`	`When to use:`
	`208`	`+`
`202`	`209`	`- Configuring development tools and CLIs`
`203`	`210`	`- Providing authentication tokens`
`204`	`211`	`- Setting service endpoints`
`205`	`212`
`206`	`213`	`Example:`
	`214`	`+`
`207`	`215`	```tf
`208`	`216`	`resource "coder_env" "config" {`
`209`	`217`	`agent_id = var.agent_id`
`@@ -230,6 +238,7 @@ data "coder_workspace_owner" "me" {}`
`230`	`238`	`###Variable Design`
`231`	`239`
`232`	`240`	`Required Variables:`
	`241`	`+`
`233`	`242`	```tf
`234`	`243`	`variable "agent_id" {`
`235`	`244`	`type = string`
`@@ -239,6 +248,7 @@ variable "agent_id" {`
`239`	`248`	```
`240`	`249`
`241`	`250`	`Optional Variables with Validation:`
	`251`	`+`
`242`	`252`	```tf
`243`	`253`	`variable "version" {`
`244`	`254`	`type = string`
`@@ -252,6 +262,7 @@ variable "version" {`
`252`	`262`	```
`253`	`263`
`254`	`264`	`Complex Configuration Objects:`
	`265`	`+`
`255`	`266`	```tf
`256`	`267`	`variable "service_config" {`
`257`	`268`	`type = object({`
`@@ -266,6 +277,7 @@ variable "service_config" {`
`266`	`277`	```
`267`	`278`
`268`	`279`	`Sensitive Variables:`
	`280`	`+`
`269`	`281`	```tf
`270`	`282`	`variable "api_key" {`
`271`	`283`	`type = string`
`@@ -278,6 +290,7 @@ variable "api_key" {`
`278`	`290`	`###Script Development`
`279`	`291`
`280`	`292`	Template-driven scripts pass variables to your`run.sh`:
	`293`	`+`
`281`	`294`	```tf
`282`	`295`	`resource "coder_script" "install" {`
`283`	`296`	`agent_id = var.agent_id`
`@@ -292,6 +305,7 @@ resource "coder_script" "install" {`
`292`	`305`	```
`293`	`306`
`294`	`307`	`Error handling in your shell scripts:`
	`308`	`+`
`295`	`309`	```bash
`296`	`310`	`#!/bin/bash`
`297`	`311`	`set -euo pipefail`
`@@ -313,6 +327,7 @@ fi`
`313`	`327`	`###Integration Patterns`
`314`	`328`
`315`	`329`	Conditional resources using`start_count`:
	`330`	`+`
`316`	`331`	```tf
`317`	`332`	`resource "coder_app" "service" {`
`318`	`333`	`count = data.coder_workspace.me.start_count`
`@@ -322,6 +337,7 @@ resource "coder_app" "service" {`
`322`	`337`	```
`323`	`338`
`324`	`339`	`Multi-step installation with dependencies:`
	`340`	`+`
`325`	`341`	```tf
`326`	`342`	`resource "coder_script" "install_deps" {`
`327`	`343`	`agent_id = var.agent_id`
`@@ -338,6 +354,7 @@ resource "coder_script" "configure_service" {`
`338`	`354`	```
`339`	`355`
`340`	`356`	`Health checks for web services:`
	`357`	`+`
`341`	`358`	```tf
`342`	`359`	`resource "coder_app" "service" {`
`343`	`360`	`agent_id = var.agent_id`
@@ -363,6 +380,7 @@ While not mandatory, tests are recommended for all modules. A `main.test.ts`
`363`	`380`	`-Required variables are properly validated`
`364`	`381`
`365`	`382`	The test framework provides utilities from`~test` import to:
	`383`	`+`
`366`	`384`	`- Initialize Terraform in the module directory`
`367`	`385`	`- Apply Terraform with test variables`
`368`	`386`	`- Validate the resulting infrastructure state`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit3379347

File tree

1 file changed

1 file changed

`‎docs/about/contributing/modules.md`

0 commit comments