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

FunctionDescription
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
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
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.
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

InterfaceDescription
CreateGithubPullRequestActionOptionsThe options passed to createPublishGithubPullRequestAction method

Variables

VariableDescription
createPublishGithubPullRequestActionCreates a Github Pull Request action.
githubModuleThe GitHub Module for the Scaffolder Backend