Skip to content

Commit 9b6e237

Browse files
authored
docs(pipelines): add philosophy disclaimer (#18244)
People keep on wanting to do their CodeDeploy deployments (to either ASGs or ECS clusters) in CDK Pipelines directly. While this is *possible* using custom steps, it's not how the library is intended to be used. Explain that up top in the README. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent df03df8 commit 9b6e237

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

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

+14-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@
1111

1212
A construct library for painless Continuous Delivery of CDK applications.
1313

14+
CDK Pipelines is an *opinionated construct library*. It is purpose-built to
15+
deploy one or more copies of your CDK applications using CloudFormation with a
16+
minimal amount of effort on your part. It is *not* intended to support arbitrary
17+
deployment pipelines, and very specifically it is not built to use CodeDeploy to
18+
applications to instances, or deploy your custom-built ECR images to an ECS
19+
cluster directly: use CDK file assets with CloudFormation Init for instances, or
20+
CDK container assets for ECS clusters instead.
21+
22+
Give the CDK Pipelines way of doing things a shot first: you might find it does
23+
everything you need. If you want or need more control, we recommend you drop
24+
down to using the `aws-codepipeline` construct library directly.
25+
1426
> This module contains two sets of APIs: an **original** and a **modern** version of
1527
CDK Pipelines. The *modern* API has been updated to be easier to work with and
1628
customize, and will be the preferred API going forward. The *original* version
@@ -728,7 +740,7 @@ Here's an example that adds a Jenkins step:
728740
```ts
729741
class MyJenkinsStep extends pipelines.Step implements pipelines.ICodePipelineActionFactory {
730742
constructor(
731-
private readonly provider: cpactions.JenkinsProvider,
743+
private readonly provider: cpactions.JenkinsProvider,
732744
private readonly input: pipelines.FileSet,
733745
) {
734746
super('MyJenkinsStep');
@@ -1392,7 +1404,7 @@ is not able to read the cloud assembly produced by the new framework version.
13921404

13931405
Solution: change the `cliVersion` first, commit, push and deploy, and only then
13941406
change the framework version.
1395-
1407+
13961408
We recommend you avoid specifying the `cliVersion` parameter at all. By default
13971409
the pipeline will use the latest CLI version, which will support all cloud assembly
13981410
versions.

0 commit comments

Comments
 (0)