Skip to content

Commit 7d230d7

Browse files
authored
docs(pipelines): add section for using a different deployment engine (#18923)
---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent db28485 commit 7d230d7

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

packages/@aws-cdk/pipelines/README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,10 @@ them. You can deploy to the same account and Region, or to a different one,
4949
with the same amount of code. The *CDK Pipelines* library takes care of the
5050
details.
5151

52-
CDK Pipelines supports multiple *deployment engines* (see below), and comes with
53-
a deployment engine that deploys CDK apps using AWS CodePipeline. To use the
54-
CodePipeline engine, define a `CodePipeline` construct. The following
52+
CDK Pipelines supports multiple *deployment engines* (see
53+
[Using a different deployment engine](#using-a-different-deployment-engine)),
54+
and comes with a deployment engine that deploys CDK apps using AWS CodePipeline.
55+
To use the CodePipeline engine, define a `CodePipeline` construct. The following
5556
example creates a CodePipeline that deploys an application from GitHub:
5657

5758
```ts
@@ -225,9 +226,10 @@ const originalPipeline = new pipelines.CdkPipeline(this, 'Pipeline', {
225226

226227
## Definining the pipeline
227228

228-
This section of the documentation describes the AWS CodePipeline engine, which
229-
comes with this library. If you want to use a different deployment engine, read
230-
the section *Using a different deployment engine* below.
229+
This section of the documentation describes the AWS CodePipeline engine,
230+
which comes with this library. If you want to use a different deployment
231+
engine, read the section
232+
[Using a different deployment engine](#using-a-different-deployment-engine)below.
231233

232234
### Synth and sources
233235

@@ -1211,6 +1213,17 @@ pipeline.addStage(stage, {
12111213
**Note**: Manual Approvals notifications only apply when an application has security
12121214
check enabled.
12131215

1216+
## Using a different deployment engine
1217+
1218+
CDK Pipelines supports multiple *deployment engines*, but this module vends a
1219+
construct for only one such engine: AWS CodePipeline. It is also possible to
1220+
use CDK Pipelines to build pipelines backed by other deployment engines.
1221+
1222+
Here is a list of CDK Libraries that integrate CDK Pipelines with
1223+
alternative deployment engines:
1224+
1225+
* GitHub Workflows: [`cdk-pipelines-github`](https://github.com/cdklabs/cdk-pipelines-github)
1226+
12141227
## Troubleshooting
12151228

12161229
Here are some common errors you may encounter while using this library.

packages/@aws-cdk/pipelines/lib/blueprint/shell-step.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,8 @@ export interface ShellStepProps {
9191
}
9292

9393
/**
94-
* Run shell script commands in the pipeline
94+
* Run shell script commands in the pipeline. This is a generic step designed
95+
* to be deployment engine agnostic.
9596
*/
9697
export class ShellStep extends Step {
9798
/**

0 commit comments

Comments
 (0)