Skip to content

Commit 98eb3b9

Browse files
committed
docs: Allow arbitrary filenames for spicepod path argument
`spice run`, `spiced`, and `spice validate` now accept any YAML file path (e.g. `spiced ./configs/my-app.yaml`) — not just files literally named `spicepod.yaml`/`spicepod.yml`. Files passed by path must declare `kind: Spicepod` and a recognized `version`, otherwise the runtime exits with an explicit validation error. - `reference/spicepod/index.md` — relax the "must be named spicepod.yaml" claim and describe the directory-vs-file behavior. - `cli/reference/run.md`, `spiced.md`, `validate.md` — clarify what the positional path argument accepts. Reflects the behavior introduced in spiceai/spiceai#10777.
1 parent 6d829cd commit 98eb3b9

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

website/docs/cli/reference/run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Flags that are passed to the `spiced` runtime directly using `--`.
4242
- `-v`, `--verbose` Enable verbose logging (use `-vv` for more detail)
4343
- `--very-verbose` Enable very verbose logging
4444
- `--set-runtime` Override [runtime configuration](../../reference/spicepod/#runtime) with a name/value pair specified as `name=value`. Multiple overrides can be specified by using the flag multiple times.
45-
- `[PATH]` Positional argument specifying the path to a Spicepod directory or file. Supports local paths and `s3://` remote URLs.
45+
- `[PATH]` Positional argument specifying the path to a Spicepod directory or file. Supports local paths and `s3://` remote URLs. Directories must contain a `spicepod.yaml` (or `spicepod.yml`); file paths can use any name as long as the file declares `kind: Spicepod` and a recognized `version`.
4646

4747
### Examples
4848

website/docs/cli/reference/spiced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Most users invoke `spiced` indirectly via [`spice run`](./run), which installs t
1717
spiced [flags] [SPICEPOD_PATH]
1818
```
1919

20-
If `SPICEPOD_PATH` is omitted, `spiced` uses the current working directory.
20+
If `SPICEPOD_PATH` is omitted, `spiced` uses the current working directory. When the path resolves to a directory, the runtime loads `spicepod.yaml` (or `spicepod.yml`) from inside it. When the path resolves to a file, any YAML filename is accepted (e.g. `spiced ./configs/my-app.yaml`); the file must declare `kind: Spicepod` and a recognized `version` — otherwise `spiced` exits with an explicit validation error.
2121

2222
### Runtime flags
2323

website/docs/cli/reference/validate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Checks YAML syntax and schema, component references, duplicate component names,
1414
spice validate [path]
1515
```
1616

17-
- `path`: Path to a `spicepod.yaml` file or a directory containing one. Defaults to the current directory (`.`).
17+
- `path`: Path to a Spicepod YAML file or a directory containing one. Defaults to the current directory (`.`). Directories must contain a `spicepod.yaml` (or `spicepod.yml`); file paths accept any name as long as the file declares `kind: Spicepod` and a recognized `version`.
1818

1919
#### Flags
2020

website/docs/reference/spicepod/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ tags:
1010
- manifest
1111
---
1212

13-
Spicepod manifests use YAML syntax. They are stored in the root directory of the application and must be named `spicepod.yaml` or `spicepod.yml`.
13+
Spicepod manifests use YAML syntax. By default they are stored in the root directory of the application and named `spicepod.yaml` or `spicepod.yml` — when the runtime is given a directory path, it looks for one of those two filenames. The runtime also accepts any YAML file path directly (e.g. `spiced ./configs/my-app.yaml`); files passed by path must declare `kind: Spicepod` and a recognized `version` and are otherwise rejected with an explicit error.
1414

1515
:::info[Tip]
1616

0 commit comments

Comments
 (0)