docs: Allow arbitrary filenames for spicepod path argument#1727
Merged
Conversation
`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.
✅ Pull with Spice PassedPassing checks:
|
|
🚀 deployed to https://da350875.spiceai-org-website.pages.dev |
phillipleblanc
approved these changes
May 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
spice run,spiced, andspice validatenow accept any YAML file path (e.g.spiced ./configs/my-app.yaml) — not just files namedspicepod.yaml/spicepod.yml. Files passed by path must declarekind: Spicepodand a recognizedversion; otherwise the runtime exits with an explicit validation error.Source PRs
kindvalidation spiceai#10777 — Allow arbitrary filenames when specifying spicepod path +kindvalidationChanges
website/docs/reference/spicepod/index.md— relax the previous "must be namedspicepod.yamlorspicepod.yml" wording and describe the directory-vs-file behavior.website/docs/cli/reference/run.md— clarify that the positional[PATH]arg accepts arbitrary YAML filenames as long as the file declareskind: Spicepod.website/docs/cli/reference/spiced.md— same clarification forSPICEPOD_PATH.website/docs/cli/reference/validate.md— same clarification for thepathargument.Test plan
cd website && npm run buildpasses locallySpicepod::load_fromand the newkind/versionvalidation incrates/spicepod/src/lib.rsspicepod.yaml/spicepod.yml) verified againsttest_load_from_directory_finds_spicepod_yaml