Moved example configuration from docs/examples/ to top-level examples/
All checks were successful
ci/woodpecker/tag/release Pipeline was successful
All checks were successful
ci/woodpecker/tag/release Pipeline was successful
This commit is contained in:
@@ -19,4 +19,4 @@ This command requires discoverable `pipeline.yml` and `session.yml` files (or ex
|
|||||||
- [Development Guide](docs/development.md)
|
- [Development Guide](docs/development.md)
|
||||||
- [Architecture Principles](docs/architecture.md)
|
- [Architecture Principles](docs/architecture.md)
|
||||||
- [Internal Component Contracts](docs/internal/README.md)
|
- [Internal Component Contracts](docs/internal/README.md)
|
||||||
- [Config Examples](docs/examples/)
|
- [Config Examples](examples/)
|
||||||
|
|||||||
@@ -294,11 +294,11 @@ Guidance:
|
|||||||
|
|
||||||
Maintained examples:
|
Maintained examples:
|
||||||
|
|
||||||
- `docs/examples/pipeline.minimal.yml`
|
- `examples/pipeline.minimal.yml`
|
||||||
- `docs/examples/pipeline.production.yml`
|
- `examples/pipeline.production.yml`
|
||||||
- `docs/examples/pipeline.full.annotated.yml`
|
- `examples/pipeline.full.annotated.yml`
|
||||||
- `docs/examples/session.template.yml`
|
- `examples/session.template.yml`
|
||||||
- `docs/examples/session.local-audio.yml`
|
- `examples/session.local-audio.yml`
|
||||||
- `docs/examples/session.s3-audio.yml`
|
- `examples/session.s3-audio.yml`
|
||||||
|
|
||||||
These examples are validated by `internal/config` tests.
|
These examples are validated by `internal/config` tests.
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ Canonical contributor workflow and engineering conventions for implemented Narra
|
|||||||
- `internal/manifest/`: session/run manifest types and persistence.
|
- `internal/manifest/`: session/run manifest types and persistence.
|
||||||
- `internal/artifacts/`: canonical local/remote path helpers and local artifact store.
|
- `internal/artifacts/`: canonical local/remote path helpers and local artifact store.
|
||||||
- `docs/`: canonical documentation set.
|
- `docs/`: canonical documentation set.
|
||||||
- `docs/examples/`: maintained config examples used by tests.
|
- `examples/`: maintained config examples used by tests.
|
||||||
|
|
||||||
## Build and test commands
|
## Build and test commands
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ For design principles and invariants, see [docs/architecture.md](./architecture.
|
|||||||
4. Add or update load/validate tests in `internal/config/*_test.go`.
|
4. Add or update load/validate tests in `internal/config/*_test.go`.
|
||||||
5. Update canonical config docs and examples:
|
5. Update canonical config docs and examples:
|
||||||
- [docs/config.md](./config.md)
|
- [docs/config.md](./config.md)
|
||||||
- relevant files under `docs/examples/`
|
- relevant files under `examples/`
|
||||||
|
|
||||||
### Add CLI flags or commands
|
### Add CLI flags or commands
|
||||||
|
|
||||||
@@ -79,7 +79,7 @@ For design principles and invariants, see [docs/architecture.md](./architecture.
|
|||||||
|
|
||||||
### Update examples
|
### Update examples
|
||||||
|
|
||||||
1. Keep canonical examples only in `docs/examples/`.
|
1. Keep canonical examples only in `examples/`.
|
||||||
2. Ensure examples load and validate through runtime config paths.
|
2. Ensure examples load and validate through runtime config paths.
|
||||||
3. Update `internal/config/load_validate_test.go` as needed.
|
3. Update `internal/config/load_validate_test.go` as needed.
|
||||||
4. Update links in `docs/config.md` if example filenames change.
|
4. Update links in `docs/config.md` if example filenames change.
|
||||||
|
|||||||
@@ -70,7 +70,7 @@ Safe Fix:
|
|||||||
|
|
||||||
Links:
|
Links:
|
||||||
- [docs/config.md](./config.md)
|
- [docs/config.md](./config.md)
|
||||||
- [docs/examples/](./examples/)
|
- [examples/](../examples/)
|
||||||
|
|
||||||
## `--artifacts` selection failure
|
## `--artifacts` selection failure
|
||||||
|
|
||||||
|
|||||||
@@ -891,7 +891,7 @@ func TestValidateMissingAudioSource(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestExamplesLoadAndValidate(t *testing.T) {
|
func TestExamplesLoadAndValidate(t *testing.T) {
|
||||||
examplesDir := filepath.Join("..", "..", "docs", "examples")
|
examplesDir := filepath.Join("..", "..", "examples")
|
||||||
tests := []struct {
|
tests := []struct {
|
||||||
name string
|
name string
|
||||||
pipelineFile string
|
pipelineFile string
|
||||||
|
|||||||
Reference in New Issue
Block a user