|
11 | 11 |
|
12 | 12 | A construct library for painless Continuous Delivery of CDK applications.
|
13 | 13 |
|
| 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 | + |
14 | 26 | > This module contains two sets of APIs: an **original** and a **modern** version of
|
15 | 27 | CDK Pipelines. The *modern* API has been updated to be easier to work with and
|
16 | 28 | 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:
|
728 | 740 | ```ts
|
729 | 741 | class MyJenkinsStep extends pipelines.Step implements pipelines.ICodePipelineActionFactory {
|
730 | 742 | constructor(
|
731 |
| - private readonly provider: cpactions.JenkinsProvider, |
| 743 | + private readonly provider: cpactions.JenkinsProvider, |
732 | 744 | private readonly input: pipelines.FileSet,
|
733 | 745 | ) {
|
734 | 746 | super('MyJenkinsStep');
|
@@ -1392,7 +1404,7 @@ is not able to read the cloud assembly produced by the new framework version.
|
1392 | 1404 |
|
1393 | 1405 | Solution: change the `cliVersion` first, commit, push and deploy, and only then
|
1394 | 1406 | change the framework version.
|
1395 |
| - |
| 1407 | + |
1396 | 1408 | We recommend you avoid specifying the `cliVersion` parameter at all. By default
|
1397 | 1409 | the pipeline will use the latest CLI version, which will support all cloud assembly
|
1398 | 1410 | versions.
|
|
0 commit comments