Skip to main content

@backstage/plugin-scaffolder-backend-module-github

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

A module for the scaffolder backend that lets you interact with github

Functions

Function

Description

createGithubActionsDispatchAction(options)

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

createGithubAutolinksAction(options)

Create an autolink reference for a repository

createGithubBranchProtectionAction(options)

Creates an github:branch-protection:create Scaffolder action that configured Branch Protection in a Github Repository.

createGithubDeployKeyAction(options)

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

createGithubEnvironmentAction(options)

Creates an github:environment:create Scaffolder action that creates a Github Environment.

createGithubIssuesLabelAction(options)

Adds labels to a pull request or issue on GitHub

createGithubPagesEnableAction(options)

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

createGithubRepoCreateAction(options)

Creates a new action that initializes a git repository

createGithubRepoPushAction(options)

Creates a new action that initializes a git repository of the content in the workspace and publishes it to GitHub.

createGithubWebhookAction(options)

Creates new action that creates a webhook for a repository on GitHub.

createPublishGithubAction(options)

Creates a new action that initializes a git repository of the content in the workspace and publishes it to GitHub.

createPublishGithubPullRequestAction(options)

Creates a Github Pull Request action.

getOctokitOptions(options)

Helper for generating octokit configuration options for given repoUrl. If no token is provided, it will attempt to get a token from the credentials provider.

Interfaces

Interface

Description

CreateGithubPullRequestActionOptions

The options passed to createPublishGithubPullRequestAction() method

Variables

Variable

Description

githubModule

The GitHub Module for the Scaffolder Backend