Backstage
Docs
Github
Preparing search index...
@backstage/plugin-scaffolder-backend-module-github
createGithubPagesEnableAction
Function createGithubPagesEnableAction
createGithubPagesEnableAction
(
options
:
{
githubCredentialsProvider
?:
GithubCredentialsProvider
;
integrations
:
ScmIntegrationRegistry
;
}
,
)
:
TemplateAction
<
{
buildType
?:
"legacy"
|
"workflow"
;
repoUrl
:
string
;
sourceBranch
?:
string
;
sourcePath
?:
"/"
|
"/docs"
;
token
?:
string
;
}
,
{
[
key
:
string
]:
any
}
,
"v2"
,
>
Creates a new action that enables GitHub Pages for a repository.
Parameters
options
:
{
githubCredentialsProvider
?:
GithubCredentialsProvider
;
integrations
:
ScmIntegrationRegistry
;
}
Returns
TemplateAction
<
{
buildType
?:
"legacy"
|
"workflow"
;
repoUrl
:
string
;
sourceBranch
?:
string
;
sourcePath
?:
"/"
|
"/docs"
;
token
?:
string
;
}
,
{
[
key
:
string
]:
any
}
,
"v2"
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Docs
Github
Backstage
Loading...
Creates a new action that enables GitHub Pages for a repository.