@mlaursen/release-script
Version:
The release script I normally use for packages I publish to npm
1 lines • 2.69 kB
Source Map (JSON)
{"version":3,"file":"index.d.ts","sources":["../types/createRelease.d.ts","../types/getPendingReleases.d.ts","../types/release.d.ts"],"sourcesContent":["export interface ConfigurableCreateReleaseOptions {\n repo: string;\n /**\n * @defaultValue `\"mlaursen\"`\n */\n owner?: string;\n /**\n * The `.env` file to load to get the {@link tokenName} environment variable.\n *\n * @defaultValue `\".env.local\"`\n */\n envPath?: string;\n /**\n * @defaultValue `\"GITHUB_RELEASE_TOKEN\"`\n */\n tokenName?: string;\n}\nexport interface CreateReleaseOptions extends ConfigurableCreateReleaseOptions {\n body: string;\n override?: boolean;\n tagName: string;\n prerelease: boolean;\n}\nexport declare function createRelease(options: CreateReleaseOptions): Promise<void>;\n","export interface GetPendingReleasesOptions {\n /**\n * This should be a record of package names to paths for monorepos.\n *\n * @example Monorepo Setup\n * ```tsx\n * packagePaths: {\n * \"@react-md/core\": \"./packages/core\",\n * \"docs\": \"./apps/docs\"\n * },\n * ```\n *\n * If this is omitted or not matched, it will default to `\".\"`\n *\n * @defaultValue `{}`\n */\n packagePaths?: Record<string, string>;\n}\nexport interface PendingRelease {\n tagName: string;\n body: string;\n}\nexport declare function getPendingReleases(options: GetPendingReleasesOptions): Promise<readonly PendingRelease[]>;\n","import { type ConfigurableCreateReleaseOptions } from \"./createRelease.js\";\nimport { type GetPendingReleasesOptions } from \"./getPendingReleases.js\";\nexport interface ReleaseOptions extends ConfigurableCreateReleaseOptions, GetPendingReleasesOptions {\n /**\n * @defaultValue `!buildCommand`\n */\n skipBuild?: boolean;\n /**\n * @defaultValue `\"clean\"`\n */\n cleanCommand?: string;\n /**\n * @defaultValue `\"build\"`\n */\n buildCommand?: string;\n /**\n * @defaultValue `\"build(version): version package\"`\n */\n versionMessage?: string;\n}\nexport declare function release(options: ReleaseOptions): Promise<void>;\n"],"names":[],"mappings":"AAAO,UAAA,gCAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,UAAA,oBAAA,SAAA,gCAAA;AACP;AACA;AACA;AACA;AACA;AACO,iBAAA,aAAA,UAAA,oBAAA,GAAA,OAAA;;ACvBA,UAAA,yBAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,mBAAA,MAAA;AACA;;ACfO,UAAA,cAAA,SAAA,gCAAA,EAAA,yBAAA;AACP;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,iBAAA,OAAA,UAAA,cAAA,GAAA,OAAA;;;;"}