Inheritance

GitHubSourceProps

Implements

Inherited Members

public class GitHubSourceProps : IGitHubSourceProps, ISourceProps

Public Class GitHubSourceProps Implements IGitHubSourceProps, ISourceProps

Construction properties for GitHubSource and GitHubEnterpriseSource.

public GitHubSourceProps()

Examples

var gitHubSource = Source.GitHub(new GitHubSourceProps {
                Owner = "aws",
                WebhookTriggersBatchBuild = true,  // optional, default is false
                WebhookFilters = new [] { FilterGroup.InEventOf(EventAction.WORKFLOW_JOB_QUEUED).AndRepositoryNameIs("aws-.*").AndRepositoryNameIsNot("aws-cdk-lib") }
            });

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build.

public string? BranchOrRef { get; set; }

Property Value

string

Examples

"mybranch";

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

public string? BuildStatusContext { get; set; }

Property Value

string

Examples

"My build #$CODEBUILD_BUILD_NUMBER";

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

public string? BuildStatusUrl { get; set; }

Property Value

string

Examples

"$CODEBUILD_PUBLIC_BUILD_URL";

The depth of history to download.

public double? CloneDepth { get; set; }

Property Value

double?

Whether to fetch submodules while cloning git repo.

public bool? FetchSubmodules { get; set; }

Property Value

bool?

The source identifier.

public string? Identifier { get; set; }

Property Value

string

The GitHub Organization/user that owns the repo.

public string Owner { get; set; }

Property Value

string

Examples

"awslabs";

The name of the repo (without the username).

public string? Repo { get; set; }

Property Value

string

Examples

"aws-cdk";

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

public bool? ReportBuildStatus { get; set; }

Property Value

bool?

Whether to create a webhook that will trigger a build every time an event happens in the repository.

public bool? Webhook { get; set; }

Property Value

bool?

A list of webhook filters that can constraint what events in the repository will trigger a build.

public FilterGroup[]? WebhookFilters { get; set; }

Property Value

FilterGroup[]

Trigger a batch build from a webhook instead of a standard one.

public bool? WebhookTriggersBatchBuild { get; set; }

Property Value

bool?