Interface PublisherGitHubConfig

interface PublisherGitHubConfig {
    authToken?: string;
    draft?: boolean;
    force?: boolean;
    generateReleaseNotes?: boolean;
    octokitOptions?: OctokitOptions;
    prerelease?: boolean;
    repository: GitHubRepository;
    tagPrefix?: string;
}

Properties

authToken? draft? force? generateReleaseNotes? octokitOptions? prerelease? repository tagPrefix?

Properties

Optional authToken

authToken?: string

An authorization token with permission to upload releases to this repository.

You can set the GITHUB_TOKEN environment variable if you don't want to hard code this into your config.

Optional draft

draft?: boolean

Whether or not this release should be tagged as a draft

Optional force

force?: boolean

Re-upload the new asset if you upload an asset with the same filename as existing asset

Optional generateReleaseNotes

generateReleaseNotes?: boolean

Whether to automatically generate release notes for the release

Optional octokitOptions

octokitOptions?: OctokitOptions

This options object is directly passed to @octokit/rest so you can customize any of the options that module uses. This is particularly helpful for publishing to GitHub Enterprise servers.

Optional prerelease

prerelease?: boolean

Whether or not this release should be tagged as a prerelease

repository

repository: GitHubRepository

Details that identify your repository (name and owner)

Optional tagPrefix

tagPrefix?: string

Prepended to the package version to determine the release name (default "v")

Settings

Member Visibility

Theme

On This Page

authTokendraftforcegenerateReleaseNotesoctokitOptionsprereleaserepositorytagPrefix