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 https://github.com/coder/registry/pull/802
This commit is contained in:
parent
057d7396ea
commit
caaff0c1e9
@ -1,25 +1,25 @@
|
|||||||
---
|
---
|
||||||
display_name: Agent Helper
|
display_name: Coder Utils
|
||||||
description: Building block for modules that need orchestrated script execution
|
description: Building block for modules that need orchestrated script execution
|
||||||
icon: ../../../../.icons/coder.svg
|
icon: ../../../../.icons/coder.svg
|
||||||
verified: false
|
verified: false
|
||||||
tags: [internal, library]
|
tags: [internal, library]
|
||||||
---
|
---
|
||||||
|
|
||||||
# Agent Helper
|
# Coder Utils
|
||||||
|
|
||||||
> [!CAUTION]
|
> [!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.
|
> 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]
|
> [!NOTE]
|
||||||
>
|
>
|
||||||
> - The `agent_name` should be the same as that of the agentapi module's `agent_name` if used together.
|
> - The `agent_name` should be the same as that of the agentapi module's `agent_name` if used together.
|
||||||
|
|
||||||
```tf
|
```tf
|
||||||
module "agent_helper" {
|
module "coder_helper" {
|
||||||
source = "registry.coder.com/coder/agent-helper/coder"
|
source = "registry.coder.com/coder/coder-utils/coder"
|
||||||
version = "1.0.0"
|
version = "1.0.0"
|
||||||
|
|
||||||
agent_id = coder_agent.main.id
|
agent_id = coder_agent.main.id
|
||||||
@ -1,7 +1,7 @@
|
|||||||
import { describe } from "bun:test";
|
import { describe } from "bun:test";
|
||||||
import { runTerraformInit, testRequiredVariables } from "~test";
|
import { runTerraformInit, testRequiredVariables } from "~test";
|
||||||
|
|
||||||
describe("agent-helper", async () => {
|
describe("coder-utils", async () => {
|
||||||
await runTerraformInit(import.meta.dir);
|
await runTerraformInit(import.meta.dir);
|
||||||
|
|
||||||
testRequiredVariables(import.meta.dir, {
|
testRequiredVariables(import.meta.dir, {
|
||||||
@ -1,4 +1,4 @@
|
|||||||
# Test for agent-helper module
|
# Test for coder-utils module
|
||||||
|
|
||||||
# Test with all scripts provided
|
# Test with all scripts provided
|
||||||
run "test_with_all_scripts" {
|
run "test_with_all_scripts" {
|
||||||
Loading…
x
Reference in New Issue
Block a user