## API Report File for "@backstage/plugin-scaffolder-backend-module-github" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts import { BackendFeature } from '@backstage/backend-plugin-api'; import { CatalogService } from '@backstage/plugin-catalog-node'; import { Config } from '@backstage/config'; import { createPullRequest } from 'octokit-plugin-create-pull-request'; import { GithubCredentialsProvider } from '@backstage/integration'; import { Octokit } from 'octokit'; import { OctokitOptions } from '@octokit/core/dist-types/types'; import { ScmIntegrationRegistry } from '@backstage/integration'; import { ScmIntegrations } from '@backstage/integration'; import { TemplateAction } from '@backstage/plugin-scaffolder-node'; // @public export function createGithubActionsDispatchAction(options: { integrations: ScmIntegrations; githubCredentialsProvider?: GithubCredentialsProvider; }): TemplateAction< { repoUrl: string; workflowId: string; branchOrTagName: string; workflowInputs?: Record | undefined; returnWorkflowRunDetails?: boolean | undefined; token?: string | undefined; }, { workflowRunId?: number | undefined; workflowRunUrl?: string | undefined; workflowRunHtmlUrl?: string | undefined; }, 'v2' >; // @public export function createGithubAutolinksAction(options: { integrations: ScmIntegrations; githubCredentialsProvider?: GithubCredentialsProvider; }): TemplateAction< { repoUrl: string; keyPrefix: string; urlTemplate: string; isAlphanumeric?: boolean | undefined; token?: string | undefined; }, { [x: string]: any; }, 'v2' >; // @public export function createGithubBranchProtectionAction(options: { integrations: ScmIntegrationRegistry; }): TemplateAction< { repoUrl: string; branch?: string | undefined; enforceAdmins?: boolean | undefined; requiredApprovingReviewCount?: number | undefined; requireCodeOwnerReviews?: boolean | undefined; dismissStaleReviews?: boolean | undefined; bypassPullRequestAllowances?: | { users?: string[] | undefined; apps?: string[] | undefined; teams?: string[] | undefined; } | undefined; restrictions?: | { users: string[]; teams: string[]; apps?: string[] | undefined; } | undefined; requiredStatusCheckContexts?: string[] | undefined; requireBranchesToBeUpToDate?: boolean | undefined; requiredConversationResolution?: boolean | undefined; requireLastPushApproval?: boolean | undefined; requiredCommitSigning?: boolean | undefined; requiredLinearHistory?: boolean | undefined; blockCreations?: boolean | undefined; token?: string | undefined; }, { [x: string]: any; }, 'v2' >; // @public export function createGithubDeployKeyAction(options: { integrations: ScmIntegrationRegistry; }): TemplateAction< { repoUrl: string; publicKey: string; privateKey: string; deployKeyName: string; privateKeySecretName?: string | undefined; token?: string | undefined; }, { privateKeySecretName: string; }, 'v2' >; // @public export function createGithubEnvironmentAction(options: { integrations: ScmIntegrationRegistry; catalog: CatalogService; }): TemplateAction< { repoUrl: string; name: string; deploymentBranchPolicy?: | { protected_branches: boolean; custom_branch_policies: boolean; } | undefined; customBranchPolicyNames?: string[] | undefined; customTagPolicyNames?: string[] | undefined; environmentVariables?: Record | undefined; secrets?: Record | undefined; token?: string | undefined; waitTimer?: number | undefined; preventSelfReview?: boolean | undefined; reviewers?: string[] | undefined; }, { [x: string]: any; }, 'v2' >; // @public export function createGithubIssuesCreateAction(options: { integrations: ScmIntegrationRegistry; githubCredentialsProvider?: GithubCredentialsProvider; }): TemplateAction< { repoUrl: string; title: string; body?: string | undefined; assignees?: string[] | undefined; milestone?: string | number | undefined; labels?: string[] | undefined; token?: string | undefined; }, { issueUrl: string; issueNumber: number; }, 'v2' >; // @public export function createGithubIssuesLabelAction(options: { integrations: ScmIntegrationRegistry; githubCredentialsProvider?: GithubCredentialsProvider; }): TemplateAction< { repoUrl: string; number: number; labels: string[]; token?: string | undefined; }, { [x: string]: any; }, 'v2' >; // @public export function createGithubPagesEnableAction(options: { integrations: ScmIntegrationRegistry; githubCredentialsProvider?: GithubCredentialsProvider; }): TemplateAction< { repoUrl: string; buildType?: 'legacy' | 'workflow' | undefined; sourceBranch?: string | undefined; sourcePath?: '/' | '/docs' | undefined; token?: string | undefined; }, { [x: string]: any; }, 'v2' >; // @public export interface CreateGithubPullRequestActionOptions { clientFactory?: (input: { integrations: ScmIntegrationRegistry; githubCredentialsProvider?: GithubCredentialsProvider; host: string; owner: string; repo: string; token?: string; }) => Promise< Octokit & { createPullRequest(options: createPullRequest.Options): Promise<{ data: { html_url: string; number: number; base: { ref: string; }; }; } | null>; } >; config?: Config; githubCredentialsProvider?: GithubCredentialsProvider; integrations: ScmIntegrationRegistry; } // @public export function createGithubRepoCreateAction(options: { integrations: ScmIntegrationRegistry; githubCredentialsProvider?: GithubCredentialsProvider; }): TemplateAction< { repoUrl: string; access?: string | undefined; allowAutoMerge?: boolean | undefined; allowMergeCommit?: boolean | undefined; allowRebaseMerge?: boolean | undefined; allowSquashMerge?: boolean | undefined; allowUpdateBranch?: boolean | undefined; autoInit?: boolean | undefined; blockCreations?: boolean | undefined; branch?: string | undefined; bypassPullRequestAllowances?: | { users?: string[] | undefined; apps?: string[] | undefined; teams?: string[] | undefined; } | undefined; collaborators?: | ( | { user: string; access: string; } | { team: string; access: string; } )[] | undefined; customProperties?: Record | undefined; defaultBranch?: string | undefined; deleteBranchOnMerge?: boolean | undefined; description?: string | undefined; dismissStaleReviews?: boolean | undefined; gitAuthorEmail?: string | undefined; gitAuthorName?: string | undefined; gitCommitMessage?: string | undefined; hasIssues?: boolean | undefined; hasProjects?: boolean | undefined; hasWiki?: boolean | undefined; homepage?: string | undefined; oidcCustomization?: | { useDefault: boolean; includeClaimKeys?: string[] | undefined; } | undefined; protectDefaultBranch?: boolean | undefined; protectEnforceAdmins?: boolean | undefined; repoVariables?: Record | undefined; repoVisibility?: 'internal' | 'private' | 'public' | undefined; requireBranchesToBeUpToDate?: boolean | undefined; requireCodeOwnerReviews?: boolean | undefined; requiredApprovingReviewCount?: number | undefined; requiredCommitSigning?: boolean | undefined; requiredConversationResolution?: boolean | undefined; requiredLinearHistory?: boolean | undefined; requiredStatusCheckContexts?: string[] | undefined; requireLastPushApproval?: boolean | undefined; restrictions?: | { users: string[]; teams: string[]; apps?: string[] | undefined; } | undefined; secrets?: Record | undefined; sourcePath?: string | undefined; squashMergeCommitMessage?: | 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK' | undefined; squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined; subscribe?: boolean | undefined; token?: string | undefined; topics?: string[] | undefined; workflowAccess?: 'none' | 'organization' | 'user' | undefined; }, { remoteUrl: string; repoContentsUrl: string; }, 'v2' >; // @public export function createGithubRepoPushAction(options: { integrations: ScmIntegrationRegistry; config: Config; githubCredentialsProvider?: GithubCredentialsProvider; }): TemplateAction< { repoUrl: string; requireCodeOwnerReviews?: boolean | undefined; dismissStaleReviews?: boolean | undefined; requiredStatusCheckContexts?: string[] | undefined; bypassPullRequestAllowances?: | { users?: string[] | undefined; apps?: string[] | undefined; teams?: string[] | undefined; } | undefined; requiredApprovingReviewCount?: number | undefined; restrictions?: | { users: string[]; teams: string[]; apps?: string[] | undefined; } | undefined; requireBranchesToBeUpToDate?: boolean | undefined; requiredConversationResolution?: boolean | undefined; requireLastPushApproval?: boolean | undefined; defaultBranch?: string | undefined; protectDefaultBranch?: boolean | undefined; protectEnforceAdmins?: boolean | undefined; gitCommitMessage?: string | undefined; gitAuthorName?: string | undefined; gitAuthorEmail?: string | undefined; sourcePath?: string | undefined; token?: string | undefined; requiredCommitSigning?: boolean | undefined; requiredLinearHistory?: boolean | undefined; }, { remoteUrl: string; repoContentsUrl: string; commitHash: string; }, 'v2' >; // @public export function createGithubWebhookAction(options: { integrations: ScmIntegrationRegistry; defaultWebhookSecret?: string; githubCredentialsProvider?: GithubCredentialsProvider; }): TemplateAction< { repoUrl: string; webhookUrl: string; webhookSecret?: string | undefined; events?: string[] | '*'[] | undefined; active?: boolean | undefined; contentType?: 'form' | 'json' | undefined; insecureSsl?: boolean | undefined; token?: string | undefined; }, { [x: string]: any; }, 'v2' >; // @public export function createPublishGithubAction(options: { integrations: ScmIntegrationRegistry; config: Config; githubCredentialsProvider?: GithubCredentialsProvider; }): TemplateAction< { repoUrl: string; description?: string | undefined; homepage?: string | undefined; access?: string | undefined; bypassPullRequestAllowances?: | { users?: string[] | undefined; apps?: string[] | undefined; teams?: string[] | undefined; } | undefined; requiredApprovingReviewCount?: number | undefined; restrictions?: | { users: string[]; teams: string[]; apps?: string[] | undefined; } | undefined; requireCodeOwnerReviews?: boolean | undefined; dismissStaleReviews?: boolean | undefined; requiredStatusCheckContexts?: string[] | undefined; requireBranchesToBeUpToDate?: boolean | undefined; requiredConversationResolution?: boolean | undefined; requireLastPushApproval?: boolean | undefined; repoVisibility?: 'internal' | 'private' | 'public' | undefined; defaultBranch?: string | undefined; protectDefaultBranch?: boolean | undefined; protectEnforceAdmins?: boolean | undefined; deleteBranchOnMerge?: boolean | undefined; gitCommitMessage?: string | undefined; gitAuthorName?: string | undefined; gitAuthorEmail?: string | undefined; allowMergeCommit?: boolean | undefined; allowSquashMerge?: boolean | undefined; squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE' | undefined; squashMergeCommitMessage?: | 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK' | undefined; allowRebaseMerge?: boolean | undefined; allowAutoMerge?: boolean | undefined; allowUpdateBranch?: boolean | undefined; sourcePath?: string | undefined; collaborators?: | ( | { user: string; access: string; } | { team: string; access: string; } )[] | undefined; hasProjects?: boolean | undefined; hasWiki?: boolean | undefined; hasIssues?: boolean | undefined; token?: string | undefined; topics?: string[] | undefined; repoVariables?: Record | undefined; secrets?: Record | undefined; oidcCustomization?: | { useDefault: boolean; includeClaimKeys?: string[] | undefined; } | undefined; requiredCommitSigning?: boolean | undefined; requiredLinearHistory?: boolean | undefined; customProperties?: Record | undefined; subscribe?: boolean | undefined; }, { remoteUrl: string; repoContentsUrl: string; commitHash: string; }, 'v2' >; // @public export const createPublishGithubPullRequestAction: ( options: CreateGithubPullRequestActionOptions, ) => TemplateAction< { repoUrl: string; branchName: string; title: string; description: string; filesToDelete?: string[] | undefined; targetBranchName?: string | undefined; draft?: boolean | undefined; sourcePath?: string | undefined; targetPath?: string | undefined; token?: string | undefined; reviewers?: string[] | undefined; assignees?: string[] | undefined; teamReviewers?: string[] | undefined; commitMessage?: string | undefined; update?: boolean | undefined; forceFork?: boolean | undefined; gitAuthorName?: string | undefined; gitAuthorEmail?: string | undefined; forceEmptyGitAuthor?: boolean | undefined; createWhenEmpty?: boolean | undefined; }, { targetBranchName: string; remoteUrl: string; pullRequestNumber: number; }, 'v2' >; // @public export function getOctokitOptions(options: { integrations: ScmIntegrationRegistry; credentialsProvider?: GithubCredentialsProvider; token?: string; host: string; owner?: string; repo?: string; }): Promise; // @public @deprecated export function getOctokitOptions(options: { integrations: ScmIntegrationRegistry; credentialsProvider?: GithubCredentialsProvider; token?: string; repoUrl: string; }): Promise; // @public const githubModule: BackendFeature; export default githubModule; ```