createGithubDeployKeyAction()

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

Creates an github:deployKey:create Scaffolder action that creates a Deploy Key

Signature:

function createGithubDeployKeyAction(options: {
    integrations: ScmIntegrationRegistry;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    repoUrl: string;
    publicKey: string;
    privateKey: string;
    deployKeyName: string;
    privateKeySecretName?: string | undefined;
    token?: string | undefined;
}, import("@backstage/types").JsonObject>;

Parameters

Parameter	Type	Description
options	{ integrations: ScmIntegrationRegistry; }

Returns:

import("@backstage/plugin-scaffolder-node").TemplateAction<{ repoUrl: string; publicKey: string; privateKey: string; deployKeyName: string; privateKeySecretName?: string | undefined; token?: string | undefined; }, import("@backstage/types").JsonObject>

Parameters​

Parameters