Skip to content

feat(calm): add deployment decorator standard to calm draft schema#2160

Open
harveymmaunders wants to merge 20 commits intofinos:mainfrom
harveymmaunders:feat/add-deployment-decorator-standard
Open

feat(calm): add deployment decorator standard to calm draft schema#2160
harveymmaunders wants to merge 20 commits intofinos:mainfrom
harveymmaunders:feat/add-deployment-decorator-standard

Conversation

@harveymmaunders
Copy link
Contributor

@harveymmaunders harveymmaunders commented Feb 23, 2026

Description

Introduces the official calm/standards/ directory with deployment decorator schema for tracking deployment information across CALM architectures. Includes base deployment schema with 6 core fields, Kubernetes extension, comprehensive examples, and updated documentation.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🎨 Code style/formatting changes
  • ♻️ Refactoring (no functional changes)
  • ⚡ Performance improvements
  • ✅ Test additions or updates
  • 🔧 Chore (maintenance, dependencies, CI, etc.)

Affected Components

  • CLI (cli/)
  • Shared (shared/)
  • CALM Widgets (calm-widgets/)
  • CALM Hub (calm-hub/)
  • CALM Hub UI (calm-hub-ui/)
  • Documentation (docs/)
  • VS Code Extension (calm-plugins/vscode/)
  • Dependencies
  • CI/CD

Commit Message Format ✅

Testing

  • I have tested my changes locally
  • I have added/updated unit tests
  • All existing tests pass

Checklist

  • My commits follow the conventional commit format
  • I have updated documentation if necessary
  • I have added tests for my changes (if applicable)
  • My changes follow the project's coding standards

Create calm/standards directory for official reusable decorator schemas
following the same organizational pattern as interfaces/ and controls/.

- Add calm/standards/ directory for reusable decorator standards
- Add base deployment.decorator.schema.json with 6 core fields
- Add kubernetes.decorator.schema.json as platform-specific extension
- Include comprehensive examples demonstrating various use cases
- Add README documentation for standards directory and deployment subdirectory

Refs finos#1908
Update decorator documentation to reflect the new deployment decorator
standard schema with 6 core fields.

- Update core-concepts/decorators.md with new schema fields
- Add deployment-end-time, deployment-environment, and deployment-notes to examples
- Update schema references to point to calm/standards/deployment/
- Update AI tools decorator-creation.md with enhanced example
- Align all documentation with the official deployment decorator standard

Closes finos#1908
Remove inline examples from schema files - examples are maintained
separately in the examples/ directory.

- Remove examples section from deployment.decorator.schema.json
- Remove examples section from kubernetes.decorator.schema.json
- Examples remain available in calm/standards/deployment/examples/

Refs finos#1908
@harveymmaunders harveymmaunders requested review from a team and markscott-ms as code owners February 23, 2026 14:05
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Feb 23, 2026

CLA Signed

The committers listed above are authorized under a signed CLA.

rocketstack-matt and others added 4 commits February 23, 2026 21:26
Remove 'deployment-' prefix from all field names for cleaner syntax:
- deployment-start-time → start-time
- deployment-status → status
- deployment-end-time → end-time
- deployment-environment → environment
- deployment-observability → observability
- deployment-notes → notes

Move kubernetes.decorator.schema.json to examples/ directory as
platform-specific example rather than separate standard.

Refs finos#1908
Update all documentation to reflect renamed fields (without 'deployment-' prefix)
and standard terminology. Simplify Kubernetes extension section to show it as an
example of platform-specific properties rather than separate schema inheritance.
Refs finos#1908
rocketstack-matt and others added 4 commits February 26, 2026 14:46
Move deployment decorator standards from calm/standards/ to
calm/draft/2026-03/standards/ to align with CALM draft versioning
structure. Remove obsolete 2183 draft meta schemas.

This consolidates the deployment decorator standard under the
2026-03 draft specification for proper version management.

Closes finos#1908
@harveymmaunders harveymmaunders force-pushed the feat/add-deployment-decorator-standard branch from a279f84 to e5b1748 Compare March 3, 2026 12:56
Update all meta schema  fields from draft/2183 to draft/2026-03
to align with correct draft version.

Ref finos#2183
Add required target-type field, remove environment, simplify kubernetes
decorator to essential fields only. Update examples and documentation.

Ref finos#1908
@harveymmaunders harveymmaunders changed the title Feat/add deployment decorator standard feat(calm) deployment decorator standard - draft Mar 3, 2026
@harveymmaunders harveymmaunders changed the title feat(calm) deployment decorator standard - draft feat(calm): add deployment decorator standard to calm draft schema Mar 4, 2026
@rocketstack-matt rocketstack-matt mentioned this pull request Mar 5, 2026
4 tasks
@harveymmaunders harveymmaunders force-pushed the feat/add-deployment-decorator-standard branch from 5210f28 to f9e3652 Compare March 11, 2026 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants