Skip to content

Commit 783e86a

Browse files
committed
fix create on stop and add warning
1 parent 43bdcbd commit 783e86a

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

registry/coder-labs/modules/archive/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,9 @@ module "archive" {
118118
- `extract_on_start` (bool, default: `false`): If true, the installer waits up to `extract_wait_timeout_seconds` for the archive path to appear and extracts it on start.
119119
- `extract_wait_timeout_seconds` (number, default: `5`): Timeout for `extract_on_start`.
120120

121+
> [!WARNING]
122+
> The `create_on_stop` feature uses the `coder_script` `run_on_stop` which may not work as expected on certain templates without additional provider configuration. The agent may be terminated before the script completes. See [coder/coder#6174](https://github.com/coder/coder/issues/6174) for provider-specific workarounds and [coder/coder#6175](https://github.com/coder/coder/issues/6175) for tracking a fix.
123+
121124
## Outputs
122125

123126
- `archive_path` (string): Full archive path computed as `output_dir/archive_name + extension`, where the extension comes from `compression`:

registry/coder-labs/modules/archive/scripts/archive-lib.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ usage_archive_create() {
4040
load_defaults
4141

4242
cat >&2 << USAGE
43-
Usage: coder-create-archive [OPTIONS] [[PATHS] ...]
43+
Usage: coder-archive-create [OPTIONS] [[PATHS] ...]
4444
Options:
4545
-c, --compression <gzip|zstd|none> Compression algorithm (default "${DEFAULT_COMPRESSION}")
4646
-C, --directory <DIRECTORY> Change to directory (default "${DEFAULT_DIRECTORY}")
@@ -148,7 +148,7 @@ usage_archive_extract() {
148148
load_defaults
149149

150150
cat >&2 << USAGE
151-
Usage: coder-extract-archive [OPTIONS]
151+
Usage: coder-archive-extract [OPTIONS]
152152
Options:
153153
-c, --compression <gzip|zstd|none> Compression algorithm (default "${DEFAULT_COMPRESSION}")
154154
-C, --directory <DIRECTORY> Change to directory (default "${DEFAULT_DIRECTORY}")

0 commit comments

Comments
 (0)