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";
    sourceBranch?: string;
    sourcePath?: "/" | "/docs";
    token?: string;
}, import("@backstage/types").JsonObject, "v1">;

Parameters

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

**Returns:**

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

Parameters​

Parameters