Version: Next

createGithubPagesEnableAction()

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

Creates a new action that enables GitHub Pages for a repository.

Signature:

function createGithubPagesEnableAction(options: {
    integrations: ScmIntegrationRegistry;
    githubCredentialsProvider?: GithubCredentialsProvider;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    buildType?: "legacy" | "workflow" | undefined;
    sourceBranch?: string | undefined;
    sourcePath?: "/" | "/docs" | undefined;
    token?: string | undefined;
}, import("@backstage/types").JsonObject>;

Parameters

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

Returns:

import("@backstage/plugin-scaffolder-node").TemplateAction<{ repoUrl: string; buildType?: "legacy" | "workflow" | undefined; sourceBranch?: string | undefined; sourcePath?: "/" | "/docs" | undefined; token?: string | undefined; }, import("@backstage/types").JsonObject>

Parameters​

Parameters