Documentation
    Preparing search index...

    Interface ReleaseOptions

    interface ReleaseOptions {
        dir?: string;
        dryRun?: boolean;
        dryRunResume?: boolean;
        fromMake?: boolean;
        interactive?: boolean;
        makeOptions?: MakeOptions;
        outDir?: string;
        publishTargets?: string[] | ForgeConfigPublisher[];
    }
    Index

    Properties

    dir? dryRun? dryRunResume? fromMake? interactive? makeOptions? outDir? publishTargets?

    Properties

    dir?: string

    The path to the app to be published

    dryRun?: boolean

    Run the package and make steps but do not release anything.

    make() now always saves its results, so this is equivalent to calling make() instead of release(). This option will be removed in a future major version.

    dryRunResume?: boolean

    Use ReleaseOptions.fromMake instead. This alias will be removed in a future major version.

    fromMake?: boolean

    Release the artifacts saved by a previous make run, instead of packaging and making the application again.

    Every make run saves a manifest of its results in <outDir>/make-results next to the artifacts in <outDir>/make. Setting this to true loads those manifests (from every platform and architecture that was made) and releases them without rebuilding, e.g. from a CI job that only has the artifacts other jobs built.

    To reuse only the packaged app and still run the makers, set MakeOptions.fromPackage in ReleaseOptions.makeOptions instead.

    interactive?: boolean

    Whether to use sensible defaults or prompt the user visually

    makeOptions?: MakeOptions

    Options object to passed through to make()

    outDir?: string

    The path to the directory containing generated distributables

    publishTargets?: string[] | ForgeConfigPublisher[]

    The publish targets, by default pulled from forge config, set this prop to override that list

    Settings

    Member Visibility

    On This Page

    Properties