ReadonlycloudReadonlynodeThe tree node.
ReadonlypropsReadonlysynthThe build step that produces the CDK Cloud Assembly
ReadonlywavesThe waves in this pipeline
ReadonlyworkflowReadonlyworkflowReadonlyworkflowInternalSupport adding stages with GitHub options to waves - should ONLY be called internally.
Use pipeline.addWave() and it'll call this when wave.addStage() is called.
pipeline.addStage() will also call this, since it calls pipeline.addWave().addStage().
Optionaloptions: AddGitHubStageOptionsOptionaloptions: WaveOptionsAdd a Wave to the pipeline, for deploying multiple Stages in parallel
Use the return object of this method to deploy multiple stages in parallel.
Example:
declare const pipeline: GitHubWorkflow; // assign pipeline a value
const wave = pipeline.addWave('MyWave');
wave.addStage(new MyStage(this, 'Stage1'));
wave.addStage(new MyStage(this, 'Stage2'));
Optionaloptions: WaveOptionsProtectedapplyOptionaloptions: { assetsMatrix?: boolean }Build assets sync steps.
Target directory.
Direction to sync.
ProtectedbuildProtectedBuild matrix for publishing job assets.
ProtectedbuildSend the current pipeline definition to the engine, and construct the pipeline
It is not possible to modify the pipeline after calling this method.
ProtectedcheckoutProtecteddoGet a map of account ids to stage names.
ProtectedmaskProtectedmoveOptionalinputs: Record<string, ActionsWorkflowCallInput>Optionalinputs: Record<string, ActionsWorkflowDispatchInput>ProtectedremoveProtectedreplaceProtectedresolveProtectedResolve file asset path.
Handles both the older behavior of placing assets directly under cdk.out and the newer behavior of placing them under an assembly directory.
Asset name.
ProtectedrunnerProtectedstepsReturns a string representation of this construct.
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple with() calls if subsequent mixins should apply to added
constructs.
The mixins to apply
This construct for chaining
Define workflow concurrency.
Renamed from concurrency to avoid shadowing the private concurrency
field introduced in cdk-pipelines-github >= 0.4.135.
StaticisChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
StaticisReturn whether the given object extends PipelineBase.
We do attribute detection since we can't reliably use 'instanceof'.
The FileSet tha contains the cloud assembly
This is the primary output of the synth step.