Package software.amazon.awscdk.services.codebuild

Interface GitHubSourceProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, SourceProps
All Known Implementing Classes:
GitHubSourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.792Z") @Stability(Stable) public interface GitHubSourceProps extends software.amazon.jsii.JsiiSerializable, SourceProps
Construction properties for GitHubSource and GitHubEnterpriseSource.

Example: 

 ISource gitHubSource = Source.gitHub(GitHubSourceProps.builder()
         .owner("awslabs")
         .repo("aws-cdk")
         .webhook(true) // optional, default: true if `webhookFilters` were provided, false otherwise
         .webhookTriggersBatchBuild(true) // optional, default is false
         .webhookFilters(List.of(FilterGroup.inEventOf(EventAction.PUSH).andBranchIs("master").andCommitMessageIs("the commit message")))
         .build());

  • Method Details

    • getOwner

      @Stability(Stable) @NotNull String getOwner()
      The GitHub account/user that owns the repo.

      Example: 

       "awslabs";

    • getRepo

      @Stability(Stable) @NotNull String getRepo()
      The name of the repo (without the username).

      Example: 

       "aws-cdk";

    • getBranchOrRef

      @Stability(Stable) @Nullable default String getBranchOrRef()
      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";

    • getBuildStatusContext

      @Stability(Stable) @Nullable default String getBuildStatusContext()
      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)"

      Example: 

       "My build #$CODEBUILD_BUILD_NUMBER";

      See Also:

    • getBuildStatusUrl

      @Stability(Stable) @Nullable default String getBuildStatusUrl()
      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

      Example: 

       "$CODEBUILD_PUBLIC_BUILD_URL";

      See Also:

    • getCloneDepth

      @Stability(Stable) @Nullable default Number getCloneDepth()
      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.

    • getFetchSubmodules

      @Stability(Stable) @Nullable default Boolean getFetchSubmodules()
      Whether to fetch submodules while cloning git repo.

      Default: false

    • getReportBuildStatus

      @Stability(Stable) @Nullable default Boolean getReportBuildStatus()
      Whether to send notifications on your build's start and end.

      Default: true

    • getWebhook

      @Stability(Stable) @Nullable default Boolean getWebhook()
      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

    • getWebhookFilters

      @Stability(Stable) @Nullable default List<FilterGroup> getWebhookFilters()
      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

    • getWebhookTriggersBatchBuild

      @Stability(Stable) @Nullable default Boolean getWebhookTriggersBatchBuild()
      Trigger a batch build from a webhook instead of a standard one.

      Enabling this will enable batch builds on the CodeBuild project.

      Default: false

    • builder

      @Stability(Stable) static GitHubSourceProps.Builder builder()
      Returns:
      a GitHubSourceProps.Builder of GitHubSourceProps