Skip to content

Commit caaff0c

Browse files
chore: rename agent-helper to coder-helper (#816)
## Description Change `agent-helper` to `coder-utils` The current tag for agent-helper needs to be deleted before this PR is merged. ## Type of Change - [x] New module - kinda.. - [ ] New template - [ ] Bug fix - [ ] Feature/enhancement - [ ] Documentation - [x] Other ## Module Information <!-- Delete this section if not applicable --> **Path:** `registry/coder/modules/coder-utils` **New version:** `v1.0.0` **Breaking change:** [X] Yes [ ] No ( Module name is changing, but this is not nested in any modules yet ) ## Testing & Validation - [x] Tests pass (`bun test`) - [x] Code formatted (`bun fmt`) - [x] Changes tested locally ## Related #802
1 parent 057d739 commit caaff0c

4 files changed

Lines changed: 7 additions & 7 deletions

File tree

registry/coder/modules/agent-helper/README.md renamed to registry/coder/modules/coder-utils/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
2-
display_name: Agent Helper
2+
display_name: Coder Utils
33
description: Building block for modules that need orchestrated script execution
44
icon: ../../../../.icons/coder.svg
55
verified: false
66
tags: [internal, library]
77
---
88

9-
# Agent Helper
9+
# Coder Utils
1010

1111
> [!CAUTION]
1212
> We do not recommend using this module directly. It is intended primarily for internal use by Coder to create modules with orchestrated script execution.
1313
14-
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.
14+
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.
1515

1616
> [!NOTE]
1717
>
1818
> - The `agent_name` should be the same as that of the agentapi module's `agent_name` if used together.
1919
2020
```tf
21-
module "agent_helper" {
22-
source = "registry.coder.com/coder/agent-helper/coder"
21+
module "coder_helper" {
22+
source = "registry.coder.com/coder/coder-utils/coder"
2323
version = "1.0.0"
2424
2525
agent_id = coder_agent.main.id

registry/coder/modules/agent-helper/main.test.ts renamed to registry/coder/modules/coder-utils/main.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { describe } from "bun:test";
22
import { runTerraformInit, testRequiredVariables } from "~test";
33

4-
describe("agent-helper", async () => {
4+
describe("coder-utils", async () => {
55
await runTerraformInit(import.meta.dir);
66

77
testRequiredVariables(import.meta.dir, {
File renamed without changes.

registry/coder/modules/agent-helper/main.tftest.hcl renamed to registry/coder/modules/coder-utils/main.tftest.hcl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test for agent-helper module
1+
# Test for coder-utils module
22

33
# Test with all scripts provided
44
run "test_with_all_scripts" {

0 commit comments

Comments
 (0)