diff --git a/registry/coder/modules/agent-helper/README.md b/registry/coder/modules/coder-utils/README.md similarity index 80% rename from registry/coder/modules/agent-helper/README.md rename to registry/coder/modules/coder-utils/README.md index 62eb3573d..7d87353e0 100644 --- a/registry/coder/modules/agent-helper/README.md +++ b/registry/coder/modules/coder-utils/README.md @@ -1,25 +1,25 @@ --- -display_name: Agent Helper +display_name: Coder Utils description: Building block for modules that need orchestrated script execution icon: ../../../../.icons/coder.svg verified: false tags: [internal, library] --- -# Agent Helper +# Coder Utils > [!CAUTION] > We do not recommend using this module directly. It is intended primarily for internal use by Coder to create modules with orchestrated script execution. -The Agent Helper module is a building block for modules that need to run multiple scripts in a specific order. It uses `coder exp sync` for dependency management and is designed for orchestrating pre-install, install, post-install, and start scripts. +The Coder Utils module is a building block for modules that need to run multiple scripts in a specific order. It uses `coder exp sync` for dependency management and is designed for orchestrating pre-install, install, post-install, and start scripts. > [!NOTE] > > - The `agent_name` should be the same as that of the agentapi module's `agent_name` if used together. ```tf -module "agent_helper" { - source = "registry.coder.com/coder/agent-helper/coder" +module "coder_helper" { + source = "registry.coder.com/coder/coder-utils/coder" version = "1.0.0" agent_id = coder_agent.main.id diff --git a/registry/coder/modules/agent-helper/main.test.ts b/registry/coder/modules/coder-utils/main.test.ts similarity index 89% rename from registry/coder/modules/agent-helper/main.test.ts rename to registry/coder/modules/coder-utils/main.test.ts index 6c1325896..5987c3288 100644 --- a/registry/coder/modules/agent-helper/main.test.ts +++ b/registry/coder/modules/coder-utils/main.test.ts @@ -1,7 +1,7 @@ import { describe } from "bun:test"; import { runTerraformInit, testRequiredVariables } from "~test"; -describe("agent-helper", async () => { +describe("coder-utils", async () => { await runTerraformInit(import.meta.dir); testRequiredVariables(import.meta.dir, { diff --git a/registry/coder/modules/agent-helper/main.tf b/registry/coder/modules/coder-utils/main.tf similarity index 100% rename from registry/coder/modules/agent-helper/main.tf rename to registry/coder/modules/coder-utils/main.tf diff --git a/registry/coder/modules/agent-helper/main.tftest.hcl b/registry/coder/modules/coder-utils/main.tftest.hcl similarity index 99% rename from registry/coder/modules/agent-helper/main.tftest.hcl rename to registry/coder/modules/coder-utils/main.tftest.hcl index 91546fb0a..d1228a6d4 100644 --- a/registry/coder/modules/agent-helper/main.tftest.hcl +++ b/registry/coder/modules/coder-utils/main.tftest.hcl @@ -1,4 +1,4 @@ -# Test for agent-helper module +# Test for coder-utils module # Test with all scripts provided run "test_with_all_scripts" {