interface ReleaseResult

Result of a release operation with comprehensive feedback

Examples

Successful release:

const result: ReleaseResult = {
  success: true,
  version: "1.2.0",
  previousVersion: "1.1.5",
  commitCount: 12,
  releaseNotes: { version: "1.2.0", ... },
  updatedFiles: ["./version.ts", "./deno.json", "./CHANGELOG.md"],
  githubReleaseUrl: "https://github.com/user/repo/releases/tag/v1.2.0"
};

Failed release:

const result: ReleaseResult = {
  success: false,
  error: "Template compilation failed: Invalid Vento syntax on line 5"
};

Properties

success: boolean

Whether the release was successful

optional
version: string

New version number (if successful)

optional
previousVersion: string

Previous version number (if successful)

optional
commitCount: number

Number of commits included in release (if successful)

Release notes generated for this version (if successful)

optional
updatedFiles: string[]

Files that were updated during release (if successful)

optional
error: string

Error message if failed

optional
githubReleaseUrl: string

GitHub release URL if created

optional
templateInfo: { compiled: boolean; compileError?: string; format: TemplateFormat; customTemplate?: boolean; }

Template processing details (if applicable)

Usage

import { type ReleaseResult } from ".";