publishGitHubRelease

Publishes a GitHub release for the new version.

Creates the release and attaches the files PublishGitHubReleaseOptions.getReleaseAssetPaths names.

Once the release exists, the issues it carries are closed with a link to it (see closeReleasedIssues), unless PublishGitHubReleaseOptions.shouldCloseReleasedIssues is false. A failure there is reported and does not fail the release, which is already published.

Import:

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

Signature:

function publishGitHubRelease(newVersion: string, options: PublishGitHubReleaseOptions): Promise<void>

Parameters:

Parameter	Type	Description
newVersion	string	The new version number for the release.
options	PublishGitHubReleaseOptions	The PublishGitHubReleaseOptions.

Returns: Promise<void> — A Promise that resolves when the release has been published.

---

Links to this page:

• PublishGitHubReleaseOptions