Skip to main content

Release Planning

The Release Planning feature helps you coordinate multi-service releases using the Release Planner standard format. You can export release data from customer sites or release topics and use it for planning, sharing, and tool integration.

Overview​

  • Where: Export from Customer Sites releases page, or from release-topic flows
  • What: Standardized JSON (Release Planner format) for release plans
  • Use case: Share plans with stakeholders, import into planning tools, coordinate multi-service deployments

What is Release Planner?​

Release Planner is a standard JSON format for tracking and managing software releases. It lets you:

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

Release Planner schema​

The format looks like this:

{
  "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"
    }
  ]
}

How to export release plans​

From customer sites​

  1. Open a customer site and go to its releases page.
  2. Click Export.
  3. The system generates a Release Planner JSON file.
  4. Download the file.

Export contents​

The file includes:

  • Metadata – Name, version, description
  • Milestone – Milestone identifier (e.g. customer site ID)
  • Release date – Earliest planned or deployed date
  • Priority – Priority level
  • Releases array – Each release with name, repo link, tag, release document, notes, description, deployment version URL

Using release plans​

After exporting you can:

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

Schema information in the app​

To view the schema and field descriptions in the application:

  1. On the releases page, click Schema Info.
  2. Review the structure and field descriptions.
  3. Preview how your data maps to the schema.

For the full schema and spec, see the Release Planner repository.