Blazing iconBlazing

Versioning

Edit on GitHub

Understanding documentation versions and API compatibility

Blazing Core Compose follows semantic versioning for both the API and documentation. This guide explains how to navigate different versions and maintain compatibility.

Current Version

Latest Stable: v0.2.0 (December 2025)

This documentation reflects v0.2.0 of the Core Compose specification.

Version Format

Blazing uses semantic versioning (semver):

Plain Text

YAML Version Declaration

Every compose.yaml file must declare its version:

YAML

Important: Only specify major.minor in YAML (e.g., v0.2, not v0.2.0). Patch versions are backward compatible within the same minor version.

Version Compatibility

API Compatibility Matrix

| YAML Version | API Versions | Status | Notes | |--------------|--------------|--------|-------| | v0.2 | v0.2.0, v0.2.1, v0.2.2 | Current | Active development | | v0.1 | v0.1.0 - v0.1.9 | Deprecated | Supported until Q2 2026 | | v0.0 | v0.0.x | Unsupported | Migrate to v0.2 |

Backward Compatibility

Minor version updates (e.g., v0.1 → v0.2) may include:

  • ✅ New optional fields
  • ✅ New provider support
  • ✅ Enhanced features
  • ❌ No breaking changes to existing configurations

Major version updates (e.g., v1.0 → v2.0) may include:

  • ⚠️ Breaking changes
  • ⚠️ Field renames or removals
  • ⚠️ Changed defaults
  • ✅ Migration guides provided

Viewing Specific Versions

Documentation Versions

Access documentation for specific versions:

CLI Version Management

Check your CLI version:

Bash

Install a specific version:

Bash

Schema Validation

Version-Specific Schemas

Each version has a JSON schema for validation:

YAML

The CLI automatically fetches the correct schema based on your version field.

Validate Against Specific Version

Bash

Migration Between Versions

Checking for Updates

Bash

Migration Tools

Automated migration between versions:

Bash

Sample migration output:

Plain Text

Version-Specific Features

Feature Availability by Version

Use the feature registry to check availability:

Bash

Changelog

View detailed changes between versions:

Bash

Deprecation Policy

Deprecation Timeline

  1. Announcement (Version N): Feature marked as deprecated
  2. Warning Period (6 months): Warnings in CLI/docs
  3. Removal (Version N+2): Feature removed

Example timeline:

Plain Text

Deprecated Features

Current deprecations in v0.2.0:

| Feature | Deprecated In | Removed In | Replacement | |---------|---------------|------------|-------------| | legacy_mode | v0.2.0 | v1.0.0 | Use standard mode | | placement.regions | v0.2.0 | v1.0.0 | Use regions.geographic_scope |

Staying Up to Date

Release Notifications

Subscribe to release notifications:

Bash

Or follow:

Version Pinning

Pin your deployment to a specific version:

YAML

API Version Negotiation

The CLI and API negotiate versions automatically:

Plain Text

Need Help?