Skip to content

PublishGitHubReleaseOptions

Options for publishGitHubRelease.

Import:

import type { PublishGitHubReleaseOptions } from '@mnaoumov/typescript-dev-toolkit/version';

Signature:

export interface PublishGitHubReleaseOptions

Properties

PropertyTypeDescription
getReleaseAssetPaths?(() => Promise<string[]>) | undefinedReturns the files to attach to the GitHub release, as paths relative to the project root. A path that does not exist is skipped.
shouldCloseReleasedIssues?booleanWhether to close the issues the release carries once it is published: every issue a commit since the previous tag names with a closing keyword (fixes #12) is closed with a Fixed in / Implemented in comment linking the release. See closeReleasedIssues.

Links to this page: