method ReleaseManager.prototype.release
ReleaseManager.prototype.release(bumpType?: BumpType): Promise<ReleaseResult>

Coordinates the entire release workflow:

  1. Validates environment and configuration
  2. Analyzes commits to determine version bump
  3. Generates release notes
  4. Updates configured files (with preview in dry-run mode)
  5. Creates git commit and tag
  6. Pushes to remote repository
  7. Creates GitHub release (if configured)
  8. Generates documentation (if enabled)

Examples

Basic release

const result = await manager.release();
if (result.success) {
  console.log(`Released version ${result.version}`);
}

Force specific version bump

const result = await manager.release(BumpType.MAJOR);
// Forces a major version bump regardless of commits

Parameters

optional
bumpType: BumpType

Optional version bump type (patch, minor, major)

Return Type

Promise<ReleaseResult>

Release result with success status and details

Throws

Error

If environment validation fails or git operations fail

Usage

import { ReleaseManager } from ".";