GitHubSourceProps

class aws_cdk.aws_codebuild.GitHubSourceProps(*, identifier=None, owner, repo, branch_or_ref=None, build_status_context=None, build_status_url=None, clone_depth=None, fetch_submodules=None, report_build_status=None, webhook=None, webhook_filters=None, webhook_triggers_batch_build=None)

Bases: 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 used
build_status_context (Optional[str]) – This parameter is used for the context parameter in the GitHub commit status. Can use built-in CodeBuild variables, like $AWS_REGION. Default: “AWS CodeBuild $AWS_REGION ($PROJECT_NAME)”
build_status_url (Optional[str]) – The URL that the build will report back to the source provider. Can use built-in CodeBuild variables, like $AWS_REGION. Default: - link to the AWS Console for CodeBuild to a particular build execution
clone_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: false
report_build_status (Optional[bool]) – Whether to send notifications on your build’s start and end. Default: true
webhook (Optional[bool]) – 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
webhook_filters (Optional[Sequence[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 if webhook was not provided as false. Default: every push and every Pull Request (create or update) triggers a build
webhook_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

ExampleMetadata:

infused

Example:

git_hub_source = codebuild.Source.git_hub(
    owner="awslabs",
    repo="aws-cdk",
    webhook=True,  # optional, default: true if `webhookFilters` were provided, false otherwise
    webhook_triggers_batch_build=True,  # optional, default is false
    webhook_filters=[
        codebuild.FilterGroup.in_event_of(codebuild.EventAction.PUSH).and_branch_is("master").and_commit_message_is("the commit message")
    ]
)

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:

"mybranch"

build_status_context

This parameter is used for the context parameter in the GitHub commit status.

Can use built-in CodeBuild variables, like $AWS_REGION.

Default:: “AWS CodeBuild $AWS_REGION ($PROJECT_NAME)”
See:: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html

Example:

"My build #$CODEBUILD_BUILD_NUMBER"

build_status_url

The URL that the build will report back to the source provider.

Can use built-in CodeBuild variables, like $AWS_REGION.

Default:

link to the AWS Console for CodeBuild to a particular build execution

See:

https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html

Example:

"$CODEBUILD_PUBLIC_BUILD_URL"

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.

fetch_submodules

Whether to fetch submodules while cloning git repo.

Default:: false

identifier

The source identifier.

This property is required on secondary sources.

owner

The GitHub account/user that owns the repo.

Example:

"awslabs"

repo

The name of the repo (without the username).

Example:

"aws-cdk"

report_build_status

Whether to send notifications on your build’s start and end.

Default:: true

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

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

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