@mlaursen/release-script/dist/index.d.ts

The release script I normally use for packages I publish to npm

interface ConfigurableCreateReleaseOptions {
    repo: string;
    /**
     * @defaultValue `"mlaursen"`
     */
    owner?: string;
    /**
     * The `.env` file to load to get the {@link tokenName} environment variable.
     *
     * @defaultValue `".env.local"`
     */
    envPath?: string;
    /**
     * @defaultValue `"GITHUB_RELEASE_TOKEN"`
     */
    tokenName?: string;
}
interface CreateReleaseOptions extends ConfigurableCreateReleaseOptions {
    body: string;
    override?: boolean;
    tagName: string;
    prerelease: boolean;
}
declare function createRelease(options: CreateReleaseOptions): Promise<void>;

interface GetPendingReleasesOptions {
    /**
     * This should be a record of package names to paths for monorepos.
     *
     * @example Monorepo Setup
     * ```tsx
     * packagePaths: {
     *   "@react-md/core": "./packages/core",
     *   "docs": "./apps/docs"
     * },
     * ```
     *
     * If this is omitted or not matched, it will default to `"."`
     *
     * @defaultValue `{}`
     */
    packagePaths?: Record<string, string>;
}

interface ReleaseOptions extends ConfigurableCreateReleaseOptions, GetPendingReleasesOptions {
    /**
     * @defaultValue `!buildCommand`
     */
    skipBuild?: boolean;
    /**
     * @defaultValue `"clean"`
     */
    cleanCommand?: string;
    /**
     * @defaultValue `"build"`
     */
    buildCommand?: string;
    /**
     * @defaultValue `"build(version): version package"`
     */
    versionMessage?: string;
}
declare function release(options: ReleaseOptions): Promise<void>;

export { createRelease, release };
export type { ConfigurableCreateReleaseOptions, CreateReleaseOptions, ReleaseOptions };
//# sourceMappingURL=index.d.ts.map