Interface GitHubEnterpriseSourceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,SourceProps
- All Known Implementing Classes:
GitHubEnterpriseSourceProps.Jsii$Proxy
GitHubEnterpriseSource
.
Example:
Project.Builder.create(this, "Project") .source(Source.gitHubEnterprise(GitHubEnterpriseSourceProps.builder() .httpsCloneUrl("https://my-github-enterprise.com/owner/repo") .build())) // Enable Docker AND custom caching .cache(Cache.local(LocalCacheMode.DOCKER_LAYER, LocalCacheMode.CUSTOM)) // BuildSpec with a 'cache' section necessary for 'CUSTOM' caching. This can // also come from 'buildspec.yml' in your source. .buildSpec(BuildSpec.fromObject(Map.of( "version", "0.2", "phases", Map.of( "build", Map.of( "commands", List.of("..."))), "cache", Map.of( "paths", List.of("/root/cachedir/**/*"))))) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forGitHubEnterpriseSourceProps
static final class
An implementation forGitHubEnterpriseSourceProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
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 String
This parameter is used for thecontext
parameter in the GitHub commit status.default String
The URL that the build will report back to the source provider.default Number
The depth of history to download.default Boolean
Whether to fetch submodules while cloning git repo.The HTTPS URL of the repository in your GitHub Enterprise installation.default Boolean
Whether to ignore SSL errors when connecting to the repository.default Boolean
Whether to send notifications on your build's start and end.default Boolean
Whether to create a webhook that will trigger a build every time an event happens in the repository.default List<FilterGroup>
A list of webhook filters that can constraint what events in the repository will trigger a build.default Boolean
Trigger a batch build from a webhook instead of a standard one.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.codebuild.SourceProps
getIdentifier
-
Method Details
-
getHttpsCloneUrl
The HTTPS URL of the repository in your GitHub Enterprise installation. -
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
This parameter is used for thecontext
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
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
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
Whether to fetch submodules while cloning git repo.Default: false
-
getIgnoreSslErrors
Whether to ignore SSL errors when connecting to the repository.Default: false
-
getReportBuildStatus
Whether to send notifications on your build's start and end.Default: true
-
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
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
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
-