Skip to main content

Exporting Data

Learn how to export release data from Release Pilot.

Export from Customer Sites​

Overview​

Export all releases attached to a customer site in Release Planner format.

Steps​

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

The file will be named: release-planner-{siteId}-{date}.json

Release Planner Format​

The exported file follows the Release Planner schema:

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

Understanding the Schema​

Top-Level Fields​

  • name: Always "Release Planner"
  • version: Version identifier (default: "R1.0")
  • description: Description from customer site or default
  • milestone_name: Customer site ID or "M1"
  • release_date: Earliest planned/deployed date (YYYY-MM-DD)
  • priority: Release priority (default: "high")

Releases Array​

Each release includes:

  • name: Release or product name
  • repo_link: Repository URL
  • tag: Version tag (e.g., "v1.0.0")
  • release_document: Documentation URL
  • note: Notes or status
  • description: Service description
  • deployment_version_url: Deployment registry URL

Viewing Schema Information​

To learn more about the schema:

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

Using Exported Data​

Exported files can be:

  • Shared with stakeholders
  • Imported into planning tools
  • Used for documentation
  • Integrated with CI/CD pipelines
  • Tracked in version control

Release Planner Standard​

This format follows the Release Planner standard. For more information, visit:

https://github.com/release-pilot/release-pilot-public/tree/master/release-planner