Skip to main content

Release Planning Feature

The Release Planning feature helps you coordinate multi-service releases using the Release Planner standard format.

What is Release Planner?​

Release Planner is a standardized JSON format for tracking and managing software releases. It allows you to:

  • Define release milestones
  • Track multiple services in a single release
  • Export release plans for sharing
  • Integrate with planning tools

Release Planner Schema​

The Release Planner format follows this structure:

{
  "name": "Release Planner",
  "version": "R1.0",
  "description": "Track and manage your software releases efficiently.",
  "milestone_name": "M1",
  "release_date": "2025-09-30",
  "priority": "high",
  "releases": [
    {
      "name": "Service A",
      "repo_link": "http://github.com/users",
      "tag": "v1.0.0",
      "release_document": "http://example.com/document.pdf",
      "note": "Roll out in wave-1",
      "description": "Core authentication service",
      "deployment_version_url": "https://registry.example.com/auth/chart/1.0.0"
    }
  ]
}

Exporting Release Plans​

From Customer Sites​

Export all releases attached to a customer site:

  1. Navigate to a customer site's releases page
  2. Click the "Export" button
  3. The system generates a Release Planner JSON file
  4. Download the file

Export Format​

The exported file includes:

  • Metadata: Release planner name, version, description
  • Milestone: Milestone identifier (uses customer site ID)
  • Release Date: Earliest planned or deployed date
  • Priority: Release priority level
  • Releases Array: All attached releases with:
    • Service name
    • Repository link
    • Version tag
    • Release documentation
    • Notes
    • Description
    • Deployment version URL

Using Release Plans​

Once exported, you can:

  • Share with stakeholders
  • Import into planning tools
  • Track release history
  • Maintain documentation
  • Coordinate multi-service deployments

Schema Information​

View the Release Planner schema details in the application:

  1. Click "Schema Info" on the releases page
  2. Review the schema structure
  3. See field descriptions
  4. Preview your export data

For more information, visit the Release Planner repository.