Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Publisher<C> Abstract

Type parameters

  • C

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Publisher<C>(config: C, platformsToPublishOn?: string[]): Publisher<C>

  • Type parameters

    • C

    Parameters

    • config: C

      A configuration object for this publisher

    • Optional platformsToPublishOn: string[]

      If you want this maker to run on platforms different from defaultPlatforms you can provide those platforms here

    Returns Publisher<C>

Properties

config

config: C

Optional defaultPlatforms

defaultPlatforms?: string[]

Abstract name

name: string

Accessors

platforms

  • get platforms(): string[]

Methods

publish

  • Publishers must implement this method to publish the artifacts returned from make calls. If any errors occur you must throw them, failing silently or simply logging will not propagate issues up to forge.

    Please note for a given version publish will be called multiple times, once for each set of "platform" and "arch". This means if you are publishing darwin and win32 artifacts to somewhere like GitHub on the first publish call you will have to create the version on GitHub and the second call will just be appending files to the existing version.

    Parameters

    Returns Promise<void | ForgeListrTaskDefinition[]>