Skip to content

fix: correct YAML structure examples in skill documentation#108

Merged
github-actions[bot] merged 1 commit intomainfrom
fix-skill-yaml-examples
Feb 2, 2026
Merged

fix: correct YAML structure examples in skill documentation#108
github-actions[bot] merged 1 commit intomainfrom
fix-skill-yaml-examples

Conversation

@stack72
Copy link
Copy Markdown
Contributor

@stack72 stack72 commented Feb 2, 2026

  • Fix model input YAML examples in swamp-model skill to match actual implementation
  • Fix workflow YAML example in swamp-workflow skill to match actual implementation
  • Update job dependency syntax from deprecated needs to dependsOn with trigger conditions

Details

The skill documentation examples were using a Kubernetes-style manifest structure with apiVersion, kind, and metadata fields
that don't exist in the actual implementation. The correct structure uses flat top-level fields (id, name, version, tags,
attributes for models; id, name, description, version, jobs for workflows).

Test plan

  • Review updated examples match actual YAML files created by swamp model create and swamp workflow create
  • Verify examples are valid according to their respective schemas

- Fix model input YAML examples in swamp-model skill to match actual implementation
- Fix workflow YAML example in swamp-workflow skill to match actual implementation
- Update job dependency syntax from deprecated `needs` to `dependsOn` with trigger conditions

## Details
The skill documentation examples were using a Kubernetes-style manifest structure with `apiVersion`, `kind`, and `metadata` fields
that don't exist in the actual implementation. The correct structure uses flat top-level fields (`id`, `name`, `version`, `tags`,
`attributes` for models; `id`, `name`, `description`, `version`, `jobs` for workflows).

## Test plan
- [ ] Review updated examples match actual YAML files created by `swamp model create` and `swamp workflow create`
- [ ] Verify examples are valid according to their respective schemas
@adamhjk
Copy link
Copy Markdown
Contributor

adamhjk commented Feb 2, 2026

this is hilarious

Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Summary

APPROVED - No blocking issues found.

This PR correctly fixes the YAML structure examples in the skill documentation to match the actual implementation.

Verified Changes

1. Model Input Structure (swamp-model/SKILL.md)

  • Removed incorrect Kubernetes-style structure (apiVersion, kind, metadata)
  • Updated to correct flat structure (id, name, version, tags, attributes)
  • ✅ Verified against ModelInputDataSchema in src/domain/models/model_input.ts

2. Workflow Structure (swamp-workflow/SKILL.md)

  • Added description field to workflow example
  • Updated needs: [build] to proper dependsOn syntax with trigger conditions
  • ✅ Verified against TriggerConditionSchema in src/domain/workflows/trigger_condition.ts
  • ✅ Matches usage pattern in integration/workflow_test.ts

Review Checklist

  • Documentation matches actual implementation
  • No code changes requiring tests
  • No security concerns
  • Follows project conventions

Minor Suggestion (non-blocking)

The file path comments were updated from inputs/swamp/echo/my-echo.yaml to .data/inputs/swamp/echo/<uuid>.yaml, which accurately reflects the actual storage location. Good attention to detail!

@github-actions github-actions bot merged commit 6c2517a into main Feb 2, 2026
3 checks passed
@github-actions github-actions bot deleted the fix-skill-yaml-examples branch February 2, 2026 13:29
keeb added a commit that referenced this pull request Apr 14, 2026
Interactive `swamp data gc` silently skipped version-count garbage
collection when no lifetime-expired data existed, and `--dry-run` under-
reported the same work. Both ran correctly only via `--force` or `--json`.

Add a `dryRun` option to `collectGarbage` so the repository can compute
would-be counts without deleting, and expose it through a new
`previewVersionGarbage` service method. Extend `DataGcPreview` with a
`versionGcItems` field, widen the CLI early-return to consider both
categories, and render the new category in log and json preview output.

Also consolidate the duplicated `parseDuration` helper into
`src/domain/data/duration.ts`, shared by the lifecycle service and the
unified data repository.

Closes #108

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants