Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(pipelines): add philosophy disclaimer #18244

Merged
merged 3 commits into from
Jan 3, 2022
Merged

docs(pipelines): add philosophy disclaimer #18244

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
170d76e
docs(pipelines): add philosophy disclaimer
rix0rrr Jan 3, 2022
0a6f011
Merge branch 'master' into huijbers/pipelines-philosophy
rix0rrr Jan 3, 2022
41ec65a
Merge branch 'master' into huijbers/pipelines-philosophy
mergify[bot] Jan 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions packages/@aws-cdk/pipelines/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,18 @@

A construct library for painless Continuous Delivery of CDK applications.

CDK Pipelines is an *opinionated construct library*. It is purpose-built to
deploy one or more copies of your CDK applications using CloudFormation with a
minimal amount of effort on your part. It is *not* intended to support arbitrary
deployment pipelines, and very specifically it is not built to use CodeDeploy to
applications to instances, or deploy your custom-built ECR images to an ECS
cluster directly: use CDK file assets with CloudFormation Init for instances, or
CDK container assets for ECS clusters instead.

Give the CDK Pipelines way of doing things a shot first: you might find it does
everything you need. If you want or need more control, we recommend you drop
down to using the `aws-codepipeline` construct library directly.

> This module contains two sets of APIs: an **original** and a **modern** version of
CDK Pipelines. The *modern* API has been updated to be easier to work with and
customize, and will be the preferred API going forward. The *original* version
Expand Down Expand Up @@ -728,7 +740,7 @@ Here's an example that adds a Jenkins step:
```ts
class MyJenkinsStep extends pipelines.Step implements pipelines.ICodePipelineActionFactory {
constructor(
private readonly provider: cpactions.JenkinsProvider,
private readonly provider: cpactions.JenkinsProvider,
private readonly input: pipelines.FileSet,
) {
super('MyJenkinsStep');
Expand Down Expand Up @@ -1392,7 +1404,7 @@ is not able to read the cloud assembly produced by the new framework version.

Solution: change the `cliVersion` first, commit, push and deploy, and only then
change the framework version.

We recommend you avoid specifying the `cliVersion` parameter at all. By default
the pipeline will use the latest CLI version, which will support all cloud assembly
versions.
Expand Down