GitHubSourceProps¶
-
class
aws_cdk.aws_codebuild.
GitHubSourceProps
(*, identifier=None, owner, repo, branch_or_ref=None, clone_depth=None, fetch_submodules=None, report_build_status=None, webhook=None, webhook_filters=None, webhook_triggers_batch_build=None)¶ Bases:
aws_cdk.aws_codebuild.SourceProps
Construction properties for {@link GitHubSource} and {@link GitHubEnterpriseSource}.
- Parameters
identifier (
Optional
[str
]) – The source identifier. This property is required on secondary sources.owner (
str
) – The GitHub account/user that owns the repo.repo (
str
) – The name of the repo (without the username).branch_or_ref (
Optional
[str
]) – The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. Default: the default branch’s HEAD commit ID is usedclone_depth (
Union
[int
,float
,None
]) – The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build of the project.fetch_submodules (
Optional
[bool
]) – Whether to fetch submodules while cloning git repo. Default: falsereport_build_status (
Optional
[bool
]) – Whether to send notifications on your build’s start and end. Default: truewebhook (
Optional
[bool
]) – Whether to create a webhook that will trigger a build every time an event happens in the repository. Default: true if anywebhookFilters
were provided, false otherwisewebhook_filters (
Optional
[List
[FilterGroup
]]) – A list of webhook filters that can constraint what events in the repository will trigger a build. A build is triggered if any of the provided filter groups match. Only valid ifwebhook
was not provided as false. Default: every push and every Pull Request (create or update) triggers a buildwebhook_triggers_batch_build (
Optional
[bool
]) – Trigger a batch build from a webhook instead of a standard one. Enabling this will enable batch builds on the CodeBuild project. Default: false
Attributes
-
branch_or_ref
¶ The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build.
- Default
the default branch’s HEAD commit ID is used
Example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 "mybranch"
- Return type
Optional
[str
]
-
clone_depth
¶ The depth of history to download.
Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build of the project.
- Return type
Union
[int
,float
,None
]
-
fetch_submodules
¶ Whether to fetch submodules while cloning git repo.
- Default
false
- Return type
Optional
[bool
]
-
identifier
¶ The source identifier.
This property is required on secondary sources.
- Return type
Optional
[str
]
-
owner
¶ The GitHub account/user that owns the repo.
Example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 "awslabs"
- Return type
str
-
repo
¶ The name of the repo (without the username).
Example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 "aws-cdk"
- Return type
str
-
report_build_status
¶ Whether to send notifications on your build’s start and end.
- Default
true
- Return type
Optional
[bool
]
-
webhook
¶ Whether to create a webhook that will trigger a build every time an event happens in the repository.
- Default
true if any
webhookFilters
were provided, false otherwise- Return type
Optional
[bool
]
-
webhook_filters
¶ A list of webhook filters that can constraint what events in the repository will trigger a build.
A build is triggered if any of the provided filter groups match. Only valid if
webhook
was not provided as false.- Default
every push and every Pull Request (create or update) triggers a build
- Return type
Optional
[List
[FilterGroup
]]
-
webhook_triggers_batch_build
¶ Trigger a batch build from a webhook instead of a standard one.
Enabling this will enable batch builds on the CodeBuild project.
- Default
false
- Return type
Optional
[bool
]