Backstage
Docs
Github
Preparing search index...
@backstage/plugin-scaffolder-backend-module-github
createGithubRepoCreateAction
Function createGithubRepoCreateAction
createGithubRepoCreateAction
(
options
:
{
githubCredentialsProvider
?:
GithubCredentialsProvider
;
integrations
:
ScmIntegrationRegistry
;
}
,
)
:
TemplateAction
<
{
access
?:
string
;
allowAutoMerge
?:
boolean
;
allowMergeCommit
?:
boolean
;
allowRebaseMerge
?:
boolean
;
allowSquashMerge
?:
boolean
;
allowUpdateBranch
?:
boolean
;
autoInit
?:
boolean
;
bypassPullRequestAllowances
?:
{
apps
?:
string
[]
;
teams
?:
string
[]
;
users
?:
string
[]
;
}
;
collaborators
?:
(
{
access
:
string
;
user
:
string
}
|
{
access
:
string
;
team
:
string
}
)
[]
;
customProperties
?:
Record
<
string
,
string
|
string
[]
>
;
deleteBranchOnMerge
?:
boolean
;
description
?:
string
;
hasIssues
?:
boolean
;
hasProjects
?:
boolean
;
hasWiki
?:
boolean
;
homepage
?:
string
;
oidcCustomization
?:
{
includeClaimKeys
?:
string
[]
;
useDefault
:
boolean
}
;
repoUrl
:
string
;
repoVariables
?:
Record
<
string
,
string
>
;
repoVisibility
?:
"private"
|
"public"
|
"internal"
;
requireBranchesToBeUpToDate
?:
boolean
;
requireCodeOwnerReviews
?:
boolean
;
requiredApprovingReviewCount
?:
number
;
requiredCommitSigning
?:
boolean
;
requiredConversationResolution
?:
boolean
;
requiredLinearHistory
?:
boolean
;
requiredStatusCheckContexts
?:
string
[]
;
restrictions
?:
{
apps
?:
string
[]
;
teams
:
string
[]
;
users
:
string
[]
}
;
secrets
?:
Record
<
string
,
string
>
;
squashMergeCommitMessage
?:
"PR_BODY"
|
"COMMIT_MESSAGES"
|
"BLANK"
;
squashMergeCommitTitle
?:
"PR_TITLE"
|
"COMMIT_OR_PR_TITLE"
;
subscribe
?:
boolean
;
token
?:
string
;
topics
?:
string
[]
;
}
,
{
remoteUrl
:
string
;
repoContentsUrl
:
string
}
,
"v2"
,
>
Creates a new action that initializes a git repository
Parameters
options
:
{
githubCredentialsProvider
?:
GithubCredentialsProvider
;
integrations
:
ScmIntegrationRegistry
;
}
Returns
TemplateAction
<
{
access
?:
string
;
allowAutoMerge
?:
boolean
;
allowMergeCommit
?:
boolean
;
allowRebaseMerge
?:
boolean
;
allowSquashMerge
?:
boolean
;
allowUpdateBranch
?:
boolean
;
autoInit
?:
boolean
;
bypassPullRequestAllowances
?:
{
apps
?:
string
[]
;
teams
?:
string
[]
;
users
?:
string
[]
;
}
;
collaborators
?:
(
{
access
:
string
;
user
:
string
}
|
{
access
:
string
;
team
:
string
}
)
[]
;
customProperties
?:
Record
<
string
,
string
|
string
[]
>
;
deleteBranchOnMerge
?:
boolean
;
description
?:
string
;
hasIssues
?:
boolean
;
hasProjects
?:
boolean
;
hasWiki
?:
boolean
;
homepage
?:
string
;
oidcCustomization
?:
{
includeClaimKeys
?:
string
[]
;
useDefault
:
boolean
}
;
repoUrl
:
string
;
repoVariables
?:
Record
<
string
,
string
>
;
repoVisibility
?:
"private"
|
"public"
|
"internal"
;
requireBranchesToBeUpToDate
?:
boolean
;
requireCodeOwnerReviews
?:
boolean
;
requiredApprovingReviewCount
?:
number
;
requiredCommitSigning
?:
boolean
;
requiredConversationResolution
?:
boolean
;
requiredLinearHistory
?:
boolean
;
requiredStatusCheckContexts
?:
string
[]
;
restrictions
?:
{
apps
?:
string
[]
;
teams
:
string
[]
;
users
:
string
[]
}
;
secrets
?:
Record
<
string
,
string
>
;
squashMergeCommitMessage
?:
"PR_BODY"
|
"COMMIT_MESSAGES"
|
"BLANK"
;
squashMergeCommitTitle
?:
"PR_TITLE"
|
"COMMIT_OR_PR_TITLE"
;
subscribe
?:
boolean
;
token
?:
string
;
topics
?:
string
[]
;
}
,
{
remoteUrl
:
string
;
repoContentsUrl
:
string
}
,
"v2"
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Docs
Github
Backstage
Loading...
Creates a new action that initializes a git repository