createGithubActionsDispatchAction()

Home > @backstage/plugin-scaffolder-backend-module-github > createGithubActionsDispatchAction

Creates a new action that dispatches a GitHub Action workflow for a given branch or tag.

Signature:

function createGithubActionsDispatchAction(options: {
    integrations: ScmIntegrations;
    githubCredentialsProvider?: GithubCredentialsProvider;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    workflowId: string;
    branchOrTagName: string;
    workflowInputs?: {
        [key: string]: string;
    } | undefined;
    token?: string | undefined;
}, import("@backstage/types").JsonObject>;

Parameters

Parameter	Type	Description
options	{ integrations: ScmIntegrations; githubCredentialsProvider?: GithubCredentialsProvider; }

Returns:

import("@backstage/plugin-scaffolder-node").TemplateAction<{ repoUrl: string; workflowId: string; branchOrTagName: string; workflowInputs?: { [key: string]: string; } | undefined; token?: string | undefined; }, import("@backstage/types").JsonObject>

Parameters​

Parameters