@kitsi/pack-github-release 0.0.2

package/dist/types/release-options.d.ts

@@ -0,0 +1,84 @@
+import type { TaskBuilder } from '@kitsi/cli';
+/**
+ * Configuration for a single package release.
+ */
+export interface PackageReleaseConfig {
+    /** Package name (e.g., '@kitsi/cli') */
+    name: string;
+    /** Git tag name for the release (e.g., '@kitsi/cli@1.0.0') */
+    tagName: string;
+    /** Version string (e.g., '1.0.0') */
+    version: string;
+    /** Path to the changelog file for release notes extraction */
+    changelogPath?: string | undefined;
+    /** Custom release title (defaults to tag name) */
+    title?: string | undefined;
+    /** Custom release body (overrides auto-generated notes) */
+    body?: string | undefined;
+    /** Build artifacts to attach to the release */
+    assets?: string[] | undefined;
+}
+/**
+ * Options for the GitHub release pack.
+ */
+export interface ReleaseOptions {
+    /**
+     * Packages to release (required if not using versionTask).
+     * Can be auto-populated from pack-version outputs.
+     */
+    packages?: PackageReleaseConfig[] | undefined;
+    /**
+     * Task that provides version information via pack-version refs.
+     * When provided, release info is extracted from the version task outputs.
+     */
+    versionTask?: TaskBuilder | undefined;
+    /** Create releases as drafts (default: false) */
+    draft?: boolean | undefined;
+    /** Mark releases as pre-release (default: false) */
+    prerelease?: boolean | undefined;
+    /**
+     * Auto-generate release notes from GitHub.
+     * When true, uses GitHub's auto-generated release notes feature.
+     * When false, extracts notes from changelogs if available.
+     * (default: true)
+     */
+    generateNotes?: boolean | undefined;
+    /**
+     * Template for release title.
+     * Supports placeholders: {name}, {version}, {tagName}
+     * (default: '{tagName}')
+     */
+    titleTemplate?: string | undefined;
+    /**
+     * Template for release body header (prepended to auto-generated notes).
+     * Supports placeholders: {name}, {version}, {tagName}
+     */
+    bodyHeader?: string | undefined;
+    /**
+     * GitHub repository in 'owner/repo' format.
+     * Auto-detected from git remote if not specified.
+     */
+    repository?: string | undefined;
+    /** Dry run mode - show what would happen without making changes */
+    dryRun?: boolean | undefined;
+    /**
+     * Make the release the "latest" release.
+     * (default: true for non-prerelease, false for prerelease)
+     */
+    latest?: boolean | undefined;
+    /**
+     * Discussion category name for the release.
+     * Creates a linked discussion when specified.
+     */
+    discussionCategory?: string | undefined;
+    /** Skip specific lifecycle steps */
+    skip?: {
+        /** Skip preflight checks */
+        preflight?: boolean | undefined;
+        /** Skip creating releases */
+        create?: boolean | undefined;
+        /** Skip uploading assets */
+        upload?: boolean | undefined;
+    } | undefined;
+}
+//# sourceMappingURL=release-options.d.ts.map

package/dist/types/release-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-options.d.ts","sourceRoot":"","sources":["../../src/types/release-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IAEb,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAEhB,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAEhB,8DAA8D;IAC9D,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3B,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE1B,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAC;IAE9C;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEtC,iDAAiD;IACjD,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE5B,oDAAoD;IACpD,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAEjC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAEpC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC,mEAAmE;IACnE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE7B;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAE7B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC,oCAAoC;IACpC,IAAI,CAAC,EACD;QACE,4BAA4B;QAC5B,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QAChC,6BAA6B;QAC7B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QAC7B,4BAA4B;QAC5B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC9B,GACD,SAAS,CAAC;CACf"}

package/dist/types/release-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=release-options.js.map

package/dist/types/release-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-options.js","sourceRoot":"","sources":["../../src/types/release-options.ts"],"names":[],"mappings":""}

package/dist/types/release-result.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Result of creating a GitHub release.
+ */
+export interface ReleaseResult {
+    /** Package name */
+    name: string;
+    /** Version that was released */
+    version: string;
+    /** Git tag name */
+    tagName: string;
+    /** URL to the GitHub release page */
+    url: string;
+    /** GitHub release ID */
+    id: string;
+    /** Whether the release was created as a draft */
+    isDraft: boolean;
+    /** Whether the release was created as a prerelease */
+    isPrerelease: boolean;
+    /** Paths of assets that were uploaded */
+    uploadedAssets: string[];
+}
+//# sourceMappingURL=release-result.d.ts.map

package/dist/types/release-result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-result.d.ts","sourceRoot":"","sources":["../../src/types/release-result.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IAEb,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAEhB,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAEhB,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IAEZ,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IAEX,iDAAiD;IACjD,OAAO,EAAE,OAAO,CAAC;IAEjB,sDAAsD;IACtD,YAAY,EAAE,OAAO,CAAC;IAEtB,yCAAyC;IACzC,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B"}

package/dist/types/release-result.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=release-result.js.map

package/dist/types/release-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"release-result.js","sourceRoot":"","sources":["../../src/types/release-result.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@kitsi/pack-github-release",
+  "version": "0.0.2",
+  "description": "Kitsi pack for publishing GitHub releases with auto-generated release notes",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "bun run tsc -p tsconfig.build.json",
+    "build:watch": "bun run tsc -p tsconfig.build.json --watch",
+    "clean": "rm -rf dist coverage",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "typecheck": "bun run tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest --watch",
+    "test:coverage": "mkdir -p reports && vitest run --coverage",
+    "prepublishOnly": "bun run clean && bun run build && bun run test"
+  },
+  "keywords": [
+    "kitsi",
+    "pack",
+    "github",
+    "release",
+    "changelog",
+    "monorepo"
+  ],
+  "author": "",
+  "license": "MIT",
+  "peerDependencies": {
+    "@kitsi/cli": ">=0.0.1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@kitsi/cli": "workspace:*",
+    "@types/bun": "^1.1.0",
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^2.1.0",
+    "bun-types": "^1.3.5",
+    "typescript": "^5.7.0",
+    "vitest": "^2.1.0"
+  }
+}