@flit/cdk-pipeline 1.0.26 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +6 -6
- package/LICENSE.txt +202 -0
- package/README.md +138 -47
- package/dist/artifact.js +1 -1
- package/dist/code-commit-source-segment.js +2 -2
- package/dist/code-star-source-segment.js +2 -2
- package/dist/git-hub-source-segment.js +2 -2
- package/dist/pipeline-segment.js +2 -2
- package/dist/pipeline.js +1 -1
- package/dist/publish-assets-action.js +1 -1
- package/dist/s3-source-segment.js +2 -2
- package/dist/segment.js +2 -2
- package/dist/source-segment.js +1 -1
- package/dist/stack-segment.js +2 -2
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +8 -7
package/.jsii
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://github.com/p-mercury"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"aws-cdk-lib": "2.
|
|
11
|
+
"aws-cdk-lib": "2.163.0",
|
|
12
12
|
"constructs": "10.4.2"
|
|
13
13
|
},
|
|
14
14
|
"dependencyClosure": {
|
|
@@ -3860,7 +3860,7 @@
|
|
|
3860
3860
|
"docs": {
|
|
3861
3861
|
"stability": "stable"
|
|
3862
3862
|
},
|
|
3863
|
-
"homepage": "https://
|
|
3863
|
+
"homepage": "https://github.com/jumper-de/cdk-pipeline",
|
|
3864
3864
|
"jsiiVersion": "5.5.4 (build 1378d94)",
|
|
3865
3865
|
"keywords": [
|
|
3866
3866
|
"aws",
|
|
@@ -3882,11 +3882,11 @@
|
|
|
3882
3882
|
},
|
|
3883
3883
|
"name": "@flit/cdk-pipeline",
|
|
3884
3884
|
"readme": {
|
|
3885
|
-
"markdown": "This library exposes a highly customizable and extensible L3 pipeline construct intended as an alternative to the CDK native L3 [CodePipeline](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines.CodePipeline.html) construct which has some inherent limitations in capability and extensibility.\n\nThe documentation provides the tools and documentation to get your own pipeline up and running and build your own custom segments.\n\n## Usage\n\n### Installation\n\nThe package is available on [NPM](https://www.npmjs.com) and can be installed using your package manager of choice:\n\n```bash\nnpm i @flit/cdk-pipeline\n\npnpm add @flit/cdk-pipeline\n\nyarn add @flit/cdk-pipeline\n```\n\n### Basics\n\nThe snippet bellow is a basic example of a pipeline which will run whenever a change is detected in a GitHub repository and which will update itself and deploy and update a user defined stack. This example demonstrates the three basic elements that make up a pipeline:\n\n#### - Pipeline\n\nThe Pipeline construct will create a CloudFormation Stack which contains the pipeline and all of the required peripheral resources to make it work.\n\n#### - Segment\n\nA Segment is simply a pre-configured set of pipeline actions which together represent a commonly used CI/CD pattern, like for example building and deploying a stack.\n\nTo build properly, a Pipeline requires at least one SourceSegment, exactly one PipelineSegment and at least one other segment.\n\n#### - Artifact\n\nAn Artifact represents a pipeline artifact which can be used to pass information between stages. Every artifact needs to be the output of exactly one Segment and can be consumed by any segments that need that output.\n\n```typescript\nimport { App, SecretValue, Stack } from \"aws-cdk-lib\";\nimport {\n Pipeline,\n GitHubSourceSegment,\n PipelineSegment,\n StackSegment,\n Artifact,\n} from \"@flit/cdk-pipeline\";\n\nconst APP = new App();\n\nconst sourceArtifact = new Artifact();\n\nnew Pipeline(APP, \"Pipeline\", {\n rootDir: \"./\",\n segments: [\n new GitHubSourceSegment({\n oauthToken: SecretValue.secretsManager(\"github-access-token\"),\n output: sourceArtifact,\n owner: \"owner-name\",\n repository: \"repo-name\",\n branch: \"branch-name\",\n }),\n new PipelineSegment({\n input: sourceArtifact,\n command: \"cdk synth Pipeline --strict --exclusively\",\n }),\n new StackSegment({\n stack: new Stack(APP, \"Stack1\"),\n input: sourceArtifact,\n command: \"cdk synth Stack1 --strict --exclusively\",\n }),\n ],\n});\n```\n\nThe above code would produce the following pipeline:\n\n<div style=\"width: 300px; height: 340px; overflow-x: hidden; overflow-y: scroll;\"><img src=\"media://pipeline-ouput-example.png\" alt=\"alt text\" width=\"100%\"></div>\n\n### Multiple stacks\n\nTo add another stack to the pipeline you simply add another `StackSegment` with a new stack instance and the pipeline will handle the rest.\n\n```typescript\nimport { App, SecretValue, Stack } from \"aws-cdk-lib\";\nimport {\n Pipeline,\n GitHubSourceSegment,\n PipelineSegment,\n StackSegment,\n Artifact,\n} from \"@flit/cdk-pipeline\";\n\nconst APP = new App();\n\nconst sourceArtifact = new Artifact();\n\nnew Pipeline(APP, \"Pipeline\", {\n rootDir: \"./\",\n segments: [\n new GitHubSourceSegment({\n oauthToken: SecretValue.secretsManager(\"github-access-token\"),\n output: sourceArtifact,\n owner: \"owner-name\",\n repository: \"repo-name\",\n branch: \"branch-name\",\n }),\n new PipelineSegment({\n input: sourceArtifact,\n command: \"cdk synth Pipeline --strict --exclusively\",\n }),\n new StackSegment({\n stack: new Stack(APP, \"Stack1\"),\n input: sourceArtifact,\n command: \"cdk synth Stack1 --strict --exclusively\",\n }),\n new StackSegment({\n stack: new Stack(APP, \"Stack2\"),\n input: sourceArtifact,\n command: \"cdk synth Stack2 --strict --exclusively\",\n }),\n ],\n});\n```\n\n### Passing assets\n\nIf a segment requires the output artifact of a previous segment then you can simply add an output artifact to the previous stage and pass it as additional input to another segment.\n\n```typescript\nimport { App, SecretValue, Stack } from \"aws-cdk-lib\";\nimport {\n Pipeline,\n GitHubSourceSegment,\n PipelineSegment,\n StackSegment,\n Artifact,\n} from \"@flit/cdk-pipeline\";\n\nconst APP = new App();\n\nconst sourceArtifact = new Artifact();\nconst stack1Artifact = new Artifact();\n\nnew Pipeline(APP, \"Pipeline\", {\n rootDir: \"./\",\n segments: [\n new GitHubSourceSegment({\n oauthToken: SecretValue.secretsManager(\"jumper-de-github-access-tokens\"),\n output: sourceArtifact,\n owner: \"p-mercury\",\n repository: \"jumper-de\",\n branch: \"main\",\n }),\n new PipelineSegment({\n input: sourceArtifact,\n command: \"cdk synth Pipeline --strict --exclusively\",\n }),\n new StackSegment({\n stack: new Stack(APP, \"Stack1\"),\n input: sourceArtifact,\n output: stack1Artifact,\n command: \"cdk synth Stack1 --strict --exclusively\",\n }),\n new StackSegment({\n stack: new Stack(APP, \"Stack2\"),\n input: [sourceArtifact, stack1Artifact],\n command: \"cdk synth Stack2 --strict --exclusively\",\n }),\n ],\n});\n```\n\n### Building your own segment\n\nThe snippet bellow is a basic example showing a custom segment which simply adds a stage with two manual approval steps into the pipeline and allows you to optional give this step a name.\n\nEach segment has two components consisting of two distinct classes:\n\n### - Segment\n\nThe main segment class is the class that will be used in your pipeline definition, and can be created by extending the `Segment` abstract class.\n\nThis class **should not** itself create any actual CDK constructs and is simply there to collect configuration trough the `constructor`. The `constructor` should take a single parameter called `props` which is a descendant of the `SegmentProps` interface.\n\nThe segment class also has to define the `construct` abstract function which returns an instance of a descendant of the `SegmentConstructed` abstract class.\n\n### - SegmentConstructed\n\nThis class will be returned by the `construct` function of your segment class and is itself a CDK construct. So in this class you can now allocate the CDK resources this segment requires as you are used to in any other CDK application.\n\nYou can pass any configuration information previously collected in the segment class trough the constructor.\n\n```typescript\nimport { IAction } from \"aws-cdk-lib/aws-codepipeline\";\nimport { ManualApprovalAction } from \"aws-cdk-lib/aws-codepipeline-actions\";\n\nimport { Segment, SegmentConstructed } from \"./segment\";\nimport { Pipeline } from \"./pipeline\";\n\nexport interface RequireApprovalSegmentProps {\n readonly name?: string;\n}\n\n/**\n * @category Segments\n */\nexport class DoubleApprovalSegment extends Segment {\n readonly props: RequireApprovalSegmentProps;\n\n constructor(props: RequireApprovalSegmentProps) {\n super({ ...props, input: undefined, output: undefined });\n this.props = props;\n }\n\n construct(scope: Pipeline): SegmentConstructed {\n return new RequireApprovalSegmentConstructed(\n scope,\n `RequireApproval`,\n this.props,\n );\n }\n}\n\nexport interface RequireApprovalSegmentConstructedProps {\n readonly name?: string;\n}\n\nexport class RequireApprovalSegmentConstructed extends SegmentConstructed {\n readonly name: string;\n readonly actions: IAction[];\n\n constructor(\n scope: Pipeline,\n id: string,\n props: RequireApprovalSegmentConstructedProps,\n ) {\n super(scope, id);\n\n this.name = props.name ?? id;\n\n this.actions = [\n new ManualApprovalAction({\n actionName: \"ApproveChanges1\",\n runOrder: 1,\n }),\n new ManualApprovalAction({\n actionName: \"ApproveChanges2\",\n runOrder: 2,\n }),\n ];\n }\n}\n```\n"
|
|
3885
|
+
"markdown": "This library exposes a highly customizable and extensible L3 pipeline construct intended as an alternative to the CDK native L3 [CodePipeline](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines.CodePipeline.html) construct which has some inherent limitations in capability and extensibility.\n\nThe documentation provides the tools and documentation to get your own pipeline up and running and build your own custom segments.\n\n## Usage\n\n### Installation\n\nThe package is available on [NPM](https://www.npmjs.com/package/@flit/cdk-pipeline) and can be installed using your package manager of choice:\n\n```bash\nnpm i @flit/cdk-pipeline\n```\n\n```bash\npnpm add @flit/cdk-pipeline\n```\n\n```bash\nyarn add @flit/cdk-pipeline\n```\n\n### Basics\n\nThe snippet bellow is a basic example of a pipeline which will run whenever a change is detected in a GitHub repository. The pipeline will update itself and, deploy and update a user defined stack. This example demonstrates the three basic elements that make up a pipeline:\n\n#### - Pipeline\n\nThe `Pipeline` construct will create a CloudFormation Stack which contains the pipeline and all of the required peripheral resources to make it work.\n\n#### - Segment\n\nA `Segment` is simply a pre-configured set of pipeline actions which together represent a commonly used CI/CD pattern, like for example building and deploying a stack.\n\nTo build properly, a Pipeline requires at least one SourceSegment, exactly one PipelineSegment and at least one other segment.\n\n#### - Artifact\n\nAn `Artifact` represents a pipeline artifact which can be used to pass information between stages. Every artifact needs to be the output of exactly one Segment and can be consumed by any segments that need that output.\n\n```typescript\nimport { App, SecretValue, Stack } from \"aws-cdk-lib\";\nimport {\n Pipeline,\n GitHubSourceSegment,\n PipelineSegment,\n StackSegment,\n Artifact,\n} from \"@flit/cdk-pipeline\";\n\nconst APP = new App();\n\nconst SOURCE_ARTIFACT = new Artifact();\nconst BUILD_ARTIFACT = new Artifact();\n\nnew Pipeline(APP, \"Pipeline\", {\n rootDir: \"./\",\n segments: [\n new CodeStarSourceSegment({\n output: SOURCE_ARTIFACT,\n connectionArn: \"code-star-connection-arn\",\n owner: \"owner-name\",\n repository: \"repo-name\",\n branch: \"branch-name\",\n }),\n new PipelineSegment({\n input: SOURCE_ARTIFACT,\n output: BUILD_ARTIFACT,\n project: {\n environment: {\n computeType: ComputeType.MEDIUM,\n buildImage: LinuxBuildImage.AMAZON_LINUX_2_ARM_3,\n privileged: true,\n },\n buildSpec: BuildSpec.fromObject({\n version: \"0.2\",\n phases: {\n install: {\n \"runtime-versions\": {\n nodejs: \"latest\",\n },\n commands: [\"npm i -g npm@latest\", \"npm ci\"],\n },\n build: {\n commands: \"cdk synth --strict --quiet\",\n },\n },\n }),\n },\n }),\n new StackSegment({\n stack: new Stack(APP, \"BackEnd\"),\n input: BUILD_ARTIFACT,\n }),\n ],\n});\n```\n\nThe above code would produce a pipeline similar to this:\n\n<img src=\"./media/pipeline-ouput-example.png?raw=true\" alt=\"alt text\" width=\"300px\">\n\n### Multiple stacks\n\nTo add another stack to the pipeline you simply add another `StackSegment` with a new stack instance and the pipeline will handle the rest.\n\n```typescript\nimport { App, SecretValue, Stack } from \"aws-cdk-lib\";\nimport {\n Pipeline,\n GitHubSourceSegment,\n PipelineSegment,\n StackSegment,\n Artifact,\n} from \"@flit/cdk-pipeline\";\n\nconst APP = new App();\n\nconst SOURCE_ARTIFACT = new Artifact();\nconst BUILD_ARTIFACT = new Artifact();\n\nnew Pipeline(APP, \"Pipeline\", {\n rootDir: \"./\",\n segments: [\n new CodeStarSourceSegment({\n output: SOURCE_ARTIFACT,\n connectionArn: \"code-star-connection-arn\",\n owner: \"owner-name\",\n repository: \"repo-name\",\n branch: \"branch-name\",\n }),\n new PipelineSegment({\n input: SOURCE_ARTIFACT,\n output: BUILD_ARTIFACT,\n project: {\n environment: {\n computeType: ComputeType.MEDIUM,\n buildImage: LinuxBuildImage.AMAZON_LINUX_2_ARM_3,\n privileged: true,\n },\n buildSpec: BuildSpec.fromObject({\n version: \"0.2\",\n phases: {\n install: {\n \"runtime-versions\": {\n nodejs: \"latest\",\n },\n commands: [\"npm i -g npm@latest\", \"npm ci\"],\n },\n build: {\n commands: \"cdk synth --strict --quiet\",\n },\n },\n }),\n },\n }),\n new StackSegment({\n stack: new Stack(APP, \"BackEnd\"),\n input: BUILD_ARTIFACT,\n }),\n new StackSegment({\n stack: new Stack(APP, \"FrontEnd\"),\n input: BUILD_ARTIFACT,\n }),\n ],\n});\n```\n\n### More complex example\n\nIn some cases you might have a build that bakes API endpoints generated by a previous stage into the stack assets during the build stage. Using the CDK native L3 [CodePipeline](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines.CodePipeline.html) construct makes this hard, but with this more flexible setup you can run another build for any stack that needs it, and use the previous stacks outputs in that build.\n\n```typescript\nimport { App, SecretValue, Stack } from \"aws-cdk-lib\";\nimport {\n Pipeline,\n GitHubSourceSegment,\n PipelineSegment,\n StackSegment,\n Artifact,\n} from \"@flit/cdk-pipeline\";\n\nconst APP = new App();\n\nconst SOURCE_ARTIFACT = new Artifact();\nconst BUILD_ARTIFACT = new Artifact();\nconst FRONT_END_OUTPUT_ARTIFACT = new Artifact();\n\nnew Pipeline(APP, \"Pipeline\", {\n rootDir: \"./\",\n segments: [\n new CodeStarSourceSegment({\n output: SOURCE_ARTIFACT,\n connectionArn: \"code-star-connection-arn\",\n owner: \"owner-name\",\n repository: \"repo-name\",\n branch: \"branch-name\",\n }),\n new PipelineSegment({\n input: SOURCE_ARTIFACT,\n output: BUILD_ARTIFACT,\n project: {\n environment: {\n computeType: ComputeType.MEDIUM,\n buildImage: LinuxBuildImage.AMAZON_LINUX_2_ARM_3,\n privileged: true,\n },\n buildSpec: BuildSpec.fromObject({\n version: \"0.2\",\n phases: {\n install: {\n \"runtime-versions\": {\n nodejs: \"latest\",\n },\n commands: [\"npm i -g npm@latest\", \"npm ci\"],\n },\n build: {\n commands: \"cdk synth --strict --quiet\",\n },\n },\n }),\n },\n }),\n new StackSegment({\n stack: new Stack(APP, \"BackEnd\"),\n input: BUILD_ARTIFACT,\n output: FRONT_END_OUTPUT_ARTIFACT,\n }),\n new StackSegment({\n stack: new Stack(APP, \"FrontEnd\"),\n input: [SOURCE_ARTIFACT, FRONT_END_OUTPUT_ARTIFACT],\n project: {\n environment: {\n computeType: ComputeType.MEDIUM,\n buildImage: LinuxBuildImage.AMAZON_LINUX_2_ARM_3,\n privileged: true,\n },\n buildSpec: BuildSpec.fromObject({\n version: \"0.2\",\n phases: {\n install: {\n \"runtime-versions\": {\n nodejs: \"latest\",\n },\n commands: [\"npm i -g npm@latest\", \"npm ci\"],\n },\n build: {\n commands: [\n \"do something with the STACK_1_OUTPUT_ARTIFACT\",\n \"cdk synth --strict --quiet\",\n ],\n },\n },\n }),\n },\n }),\n ],\n});\n```\n\nThis example first build the project, deploys the `Pipeline` and `BackEnd` stacks and then rebuilds the project now with access to the outputs of the `BackEnd` stack. This allows you to now bake in any API endpoints dynamically generated in the `BackEnd` stack.\n\n### Building your own segment\n\nThe snippet bellow is a basic example showing a custom segment which simply adds a stage with two manual approval steps into the pipeline and allows you to optional give this step a name.\n\nEach segment has two components consisting of two distinct classes:\n\n### - Segment\n\nThe main segment class is the class that will be used in your pipeline definition, and can be created by extending the `Segment` abstract class.\n\nThis class **should not** itself create any actual CDK constructs and is simply there to collect configuration trough the `constructor`. The `constructor` should take a single parameter called `props` which is a descendant of the `SegmentProps` interface.\n\nThe segment class also has to define the `construct` abstract function which returns an instance of a descendant of the `SegmentConstructed` abstract class.\n\n### - SegmentConstructed\n\nThis class will be returned by the `construct` function of your segment class and is itself a CDK construct. So in this class you can now allocate the CDK resources this segment requires as you are used to in any other CDK application.\n\nYou can pass any configuration information previously collected in the segment class trough the constructor.\n\n```typescript\nimport { IAction } from \"aws-cdk-lib/aws-codepipeline\";\nimport { ManualApprovalAction } from \"aws-cdk-lib/aws-codepipeline-actions\";\n\nimport { Segment, SegmentConstructed } from \"./segment\";\nimport { Pipeline } from \"./pipeline\";\n\nexport interface RequireApprovalSegmentProps {\n readonly name?: string;\n}\n\n/**\n * @category Segments\n */\nexport class DoubleApprovalSegment extends Segment {\n readonly props: RequireApprovalSegmentProps;\n\n constructor(props: RequireApprovalSegmentProps) {\n super({ ...props, input: undefined, output: undefined });\n this.props = props;\n }\n\n construct(scope: Pipeline): SegmentConstructed {\n return new RequireApprovalSegmentConstructed(\n scope,\n `RequireApproval`,\n this.props,\n );\n }\n}\n\nexport interface RequireApprovalSegmentConstructedProps {\n readonly name?: string;\n}\n\nexport class RequireApprovalSegmentConstructed extends SegmentConstructed {\n readonly name: string;\n readonly actions: IAction[];\n\n constructor(\n scope: Pipeline,\n id: string,\n props: RequireApprovalSegmentConstructedProps,\n ) {\n super(scope, id);\n\n this.name = props.name ?? id;\n\n this.actions = [\n new ManualApprovalAction({\n actionName: \"ApproveChanges1\",\n runOrder: 1,\n }),\n new ManualApprovalAction({\n actionName: \"ApproveChanges2\",\n runOrder: 2,\n }),\n ];\n }\n}\n```\n"
|
|
3886
3886
|
},
|
|
3887
3887
|
"repository": {
|
|
3888
3888
|
"type": "git",
|
|
3889
|
-
"url": "https://github.com/
|
|
3889
|
+
"url": "https://github.com/jumper-de/cdk-pipeline.git"
|
|
3890
3890
|
},
|
|
3891
3891
|
"schema": "jsii/0.10.0",
|
|
3892
3892
|
"targets": {
|
|
@@ -7505,6 +7505,6 @@
|
|
|
7505
7505
|
"symbolId": "src/stack-segment:StackSegmentProps"
|
|
7506
7506
|
}
|
|
7507
7507
|
},
|
|
7508
|
-
"version": "1.0
|
|
7509
|
-
"fingerprint": "
|
|
7508
|
+
"version": "1.1.0",
|
|
7509
|
+
"fingerprint": "j1HYL3+TS9bKTXU1vIguwXF/bC0i2427OG26kmPysa8="
|
|
7510
7510
|
}
|
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -6,33 +6,37 @@ The documentation provides the tools and documentation to get your own pipeline
|
|
|
6
6
|
|
|
7
7
|
### Installation
|
|
8
8
|
|
|
9
|
-
The package is available on [NPM](https://www.npmjs.com) and can be installed using your package manager of choice:
|
|
9
|
+
The package is available on [NPM](https://www.npmjs.com/package/@flit/cdk-pipeline) and can be installed using your package manager of choice:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
npm i @flit/cdk-pipeline
|
|
13
|
+
```
|
|
13
14
|
|
|
15
|
+
```bash
|
|
14
16
|
pnpm add @flit/cdk-pipeline
|
|
17
|
+
```
|
|
15
18
|
|
|
19
|
+
```bash
|
|
16
20
|
yarn add @flit/cdk-pipeline
|
|
17
21
|
```
|
|
18
22
|
|
|
19
23
|
### Basics
|
|
20
24
|
|
|
21
|
-
The snippet bellow is a basic example of a pipeline which will run whenever a change is detected in a GitHub repository
|
|
25
|
+
The snippet bellow is a basic example of a pipeline which will run whenever a change is detected in a GitHub repository. The pipeline will update itself and, deploy and update a user defined stack. This example demonstrates the three basic elements that make up a pipeline:
|
|
22
26
|
|
|
23
27
|
#### - Pipeline
|
|
24
28
|
|
|
25
|
-
The Pipeline construct will create a CloudFormation Stack which contains the pipeline and all of the required peripheral resources to make it work.
|
|
29
|
+
The `Pipeline` construct will create a CloudFormation Stack which contains the pipeline and all of the required peripheral resources to make it work.
|
|
26
30
|
|
|
27
31
|
#### - Segment
|
|
28
32
|
|
|
29
|
-
A Segment is simply a pre-configured set of pipeline actions which together represent a commonly used CI/CD pattern, like for example building and deploying a stack.
|
|
33
|
+
A `Segment` is simply a pre-configured set of pipeline actions which together represent a commonly used CI/CD pattern, like for example building and deploying a stack.
|
|
30
34
|
|
|
31
35
|
To build properly, a Pipeline requires at least one SourceSegment, exactly one PipelineSegment and at least one other segment.
|
|
32
36
|
|
|
33
37
|
#### - Artifact
|
|
34
38
|
|
|
35
|
-
An Artifact represents a pipeline artifact which can be used to pass information between stages. Every artifact needs to be the output of exactly one Segment and can be consumed by any segments that need that output.
|
|
39
|
+
An `Artifact` represents a pipeline artifact which can be used to pass information between stages. Every artifact needs to be the output of exactly one Segment and can be consumed by any segments that need that output.
|
|
36
40
|
|
|
37
41
|
```typescript
|
|
38
42
|
import { App, SecretValue, Stack } from "aws-cdk-lib";
|
|
@@ -46,34 +50,55 @@ import {
|
|
|
46
50
|
|
|
47
51
|
const APP = new App();
|
|
48
52
|
|
|
49
|
-
const
|
|
53
|
+
const SOURCE_ARTIFACT = new Artifact();
|
|
54
|
+
const BUILD_ARTIFACT = new Artifact();
|
|
50
55
|
|
|
51
56
|
new Pipeline(APP, "Pipeline", {
|
|
52
57
|
rootDir: "./",
|
|
53
58
|
segments: [
|
|
54
|
-
new
|
|
55
|
-
|
|
56
|
-
|
|
59
|
+
new CodeStarSourceSegment({
|
|
60
|
+
output: SOURCE_ARTIFACT,
|
|
61
|
+
connectionArn: "code-star-connection-arn",
|
|
57
62
|
owner: "owner-name",
|
|
58
63
|
repository: "repo-name",
|
|
59
64
|
branch: "branch-name",
|
|
60
65
|
}),
|
|
61
66
|
new PipelineSegment({
|
|
62
|
-
input:
|
|
63
|
-
|
|
67
|
+
input: SOURCE_ARTIFACT,
|
|
68
|
+
output: BUILD_ARTIFACT,
|
|
69
|
+
project: {
|
|
70
|
+
environment: {
|
|
71
|
+
computeType: ComputeType.MEDIUM,
|
|
72
|
+
buildImage: LinuxBuildImage.AMAZON_LINUX_2_ARM_3,
|
|
73
|
+
privileged: true,
|
|
74
|
+
},
|
|
75
|
+
buildSpec: BuildSpec.fromObject({
|
|
76
|
+
version: "0.2",
|
|
77
|
+
phases: {
|
|
78
|
+
install: {
|
|
79
|
+
"runtime-versions": {
|
|
80
|
+
nodejs: "latest",
|
|
81
|
+
},
|
|
82
|
+
commands: ["npm i -g npm@latest", "npm ci"],
|
|
83
|
+
},
|
|
84
|
+
build: {
|
|
85
|
+
commands: "cdk synth --strict --quiet",
|
|
86
|
+
},
|
|
87
|
+
},
|
|
88
|
+
}),
|
|
89
|
+
},
|
|
64
90
|
}),
|
|
65
91
|
new StackSegment({
|
|
66
|
-
stack: new Stack(APP, "
|
|
67
|
-
input:
|
|
68
|
-
command: "cdk synth Stack1 --strict --exclusively",
|
|
92
|
+
stack: new Stack(APP, "BackEnd"),
|
|
93
|
+
input: BUILD_ARTIFACT,
|
|
69
94
|
}),
|
|
70
95
|
],
|
|
71
96
|
});
|
|
72
97
|
```
|
|
73
98
|
|
|
74
|
-
The above code would produce
|
|
99
|
+
The above code would produce a pipeline similar to this:
|
|
75
100
|
|
|
76
|
-
<
|
|
101
|
+
<img src="./media/pipeline-ouput-example.png?raw=true" alt="alt text" width="300px">
|
|
77
102
|
|
|
78
103
|
### Multiple stacks
|
|
79
104
|
|
|
@@ -91,39 +116,59 @@ import {
|
|
|
91
116
|
|
|
92
117
|
const APP = new App();
|
|
93
118
|
|
|
94
|
-
const
|
|
119
|
+
const SOURCE_ARTIFACT = new Artifact();
|
|
120
|
+
const BUILD_ARTIFACT = new Artifact();
|
|
95
121
|
|
|
96
122
|
new Pipeline(APP, "Pipeline", {
|
|
97
123
|
rootDir: "./",
|
|
98
124
|
segments: [
|
|
99
|
-
new
|
|
100
|
-
|
|
101
|
-
|
|
125
|
+
new CodeStarSourceSegment({
|
|
126
|
+
output: SOURCE_ARTIFACT,
|
|
127
|
+
connectionArn: "code-star-connection-arn",
|
|
102
128
|
owner: "owner-name",
|
|
103
129
|
repository: "repo-name",
|
|
104
130
|
branch: "branch-name",
|
|
105
131
|
}),
|
|
106
132
|
new PipelineSegment({
|
|
107
|
-
input:
|
|
108
|
-
|
|
133
|
+
input: SOURCE_ARTIFACT,
|
|
134
|
+
output: BUILD_ARTIFACT,
|
|
135
|
+
project: {
|
|
136
|
+
environment: {
|
|
137
|
+
computeType: ComputeType.MEDIUM,
|
|
138
|
+
buildImage: LinuxBuildImage.AMAZON_LINUX_2_ARM_3,
|
|
139
|
+
privileged: true,
|
|
140
|
+
},
|
|
141
|
+
buildSpec: BuildSpec.fromObject({
|
|
142
|
+
version: "0.2",
|
|
143
|
+
phases: {
|
|
144
|
+
install: {
|
|
145
|
+
"runtime-versions": {
|
|
146
|
+
nodejs: "latest",
|
|
147
|
+
},
|
|
148
|
+
commands: ["npm i -g npm@latest", "npm ci"],
|
|
149
|
+
},
|
|
150
|
+
build: {
|
|
151
|
+
commands: "cdk synth --strict --quiet",
|
|
152
|
+
},
|
|
153
|
+
},
|
|
154
|
+
}),
|
|
155
|
+
},
|
|
109
156
|
}),
|
|
110
157
|
new StackSegment({
|
|
111
|
-
stack: new Stack(APP, "
|
|
112
|
-
input:
|
|
113
|
-
command: "cdk synth Stack1 --strict --exclusively",
|
|
158
|
+
stack: new Stack(APP, "BackEnd"),
|
|
159
|
+
input: BUILD_ARTIFACT,
|
|
114
160
|
}),
|
|
115
161
|
new StackSegment({
|
|
116
|
-
stack: new Stack(APP, "
|
|
117
|
-
input:
|
|
118
|
-
command: "cdk synth Stack2 --strict --exclusively",
|
|
162
|
+
stack: new Stack(APP, "FrontEnd"),
|
|
163
|
+
input: BUILD_ARTIFACT,
|
|
119
164
|
}),
|
|
120
165
|
],
|
|
121
166
|
});
|
|
122
167
|
```
|
|
123
168
|
|
|
124
|
-
###
|
|
169
|
+
### More complex example
|
|
125
170
|
|
|
126
|
-
|
|
171
|
+
In some cases you might have a build that bakes API endpoints generated by a previous stage into the stack assets during the build stage. Using the CDK native L3 [CodePipeline](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.pipelines.CodePipeline.html) construct makes this hard, but with this more flexible setup you can run another build for any stack that needs it, and use the previous stacks outputs in that build.
|
|
127
172
|
|
|
128
173
|
```typescript
|
|
129
174
|
import { App, SecretValue, Stack } from "aws-cdk-lib";
|
|
@@ -137,38 +182,84 @@ import {
|
|
|
137
182
|
|
|
138
183
|
const APP = new App();
|
|
139
184
|
|
|
140
|
-
const
|
|
141
|
-
const
|
|
185
|
+
const SOURCE_ARTIFACT = new Artifact();
|
|
186
|
+
const BUILD_ARTIFACT = new Artifact();
|
|
187
|
+
const FRONT_END_OUTPUT_ARTIFACT = new Artifact();
|
|
142
188
|
|
|
143
189
|
new Pipeline(APP, "Pipeline", {
|
|
144
190
|
rootDir: "./",
|
|
145
191
|
segments: [
|
|
146
|
-
new
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
owner: "
|
|
150
|
-
repository: "
|
|
151
|
-
branch: "
|
|
192
|
+
new CodeStarSourceSegment({
|
|
193
|
+
output: SOURCE_ARTIFACT,
|
|
194
|
+
connectionArn: "code-star-connection-arn",
|
|
195
|
+
owner: "owner-name",
|
|
196
|
+
repository: "repo-name",
|
|
197
|
+
branch: "branch-name",
|
|
152
198
|
}),
|
|
153
199
|
new PipelineSegment({
|
|
154
|
-
input:
|
|
155
|
-
|
|
200
|
+
input: SOURCE_ARTIFACT,
|
|
201
|
+
output: BUILD_ARTIFACT,
|
|
202
|
+
project: {
|
|
203
|
+
environment: {
|
|
204
|
+
computeType: ComputeType.MEDIUM,
|
|
205
|
+
buildImage: LinuxBuildImage.AMAZON_LINUX_2_ARM_3,
|
|
206
|
+
privileged: true,
|
|
207
|
+
},
|
|
208
|
+
buildSpec: BuildSpec.fromObject({
|
|
209
|
+
version: "0.2",
|
|
210
|
+
phases: {
|
|
211
|
+
install: {
|
|
212
|
+
"runtime-versions": {
|
|
213
|
+
nodejs: "latest",
|
|
214
|
+
},
|
|
215
|
+
commands: ["npm i -g npm@latest", "npm ci"],
|
|
216
|
+
},
|
|
217
|
+
build: {
|
|
218
|
+
commands: "cdk synth --strict --quiet",
|
|
219
|
+
},
|
|
220
|
+
},
|
|
221
|
+
}),
|
|
222
|
+
},
|
|
156
223
|
}),
|
|
157
224
|
new StackSegment({
|
|
158
|
-
stack: new Stack(APP, "
|
|
159
|
-
input:
|
|
160
|
-
output:
|
|
161
|
-
command: "cdk synth Stack1 --strict --exclusively",
|
|
225
|
+
stack: new Stack(APP, "BackEnd"),
|
|
226
|
+
input: BUILD_ARTIFACT,
|
|
227
|
+
output: FRONT_END_OUTPUT_ARTIFACT,
|
|
162
228
|
}),
|
|
163
229
|
new StackSegment({
|
|
164
|
-
stack: new Stack(APP, "
|
|
165
|
-
input: [
|
|
166
|
-
|
|
230
|
+
stack: new Stack(APP, "FrontEnd"),
|
|
231
|
+
input: [SOURCE_ARTIFACT, FRONT_END_OUTPUT_ARTIFACT],
|
|
232
|
+
project: {
|
|
233
|
+
environment: {
|
|
234
|
+
computeType: ComputeType.MEDIUM,
|
|
235
|
+
buildImage: LinuxBuildImage.AMAZON_LINUX_2_ARM_3,
|
|
236
|
+
privileged: true,
|
|
237
|
+
},
|
|
238
|
+
buildSpec: BuildSpec.fromObject({
|
|
239
|
+
version: "0.2",
|
|
240
|
+
phases: {
|
|
241
|
+
install: {
|
|
242
|
+
"runtime-versions": {
|
|
243
|
+
nodejs: "latest",
|
|
244
|
+
},
|
|
245
|
+
commands: ["npm i -g npm@latest", "npm ci"],
|
|
246
|
+
},
|
|
247
|
+
build: {
|
|
248
|
+
commands: [
|
|
249
|
+
"do something with the STACK_1_OUTPUT_ARTIFACT",
|
|
250
|
+
"cdk synth --strict --quiet",
|
|
251
|
+
],
|
|
252
|
+
},
|
|
253
|
+
},
|
|
254
|
+
}),
|
|
255
|
+
},
|
|
167
256
|
}),
|
|
168
257
|
],
|
|
169
258
|
});
|
|
170
259
|
```
|
|
171
260
|
|
|
261
|
+
This example first build the project, deploys the `Pipeline` and `BackEnd` stacks and then rebuilds the project now with access to the outputs of the `BackEnd` stack. This allows you to now bake in any API endpoints dynamically generated in the `BackEnd` stack.
|
|
262
|
+
|
|
172
263
|
### Building your own segment
|
|
173
264
|
|
|
174
265
|
The snippet bellow is a basic example showing a custom segment which simply adds a stage with two manual approval steps into the pipeline and allows you to optional give this step a name.
|
package/dist/artifact.js
CHANGED
|
@@ -26,5 +26,5 @@ class Artifact extends aws_codepipeline_1.Artifact {
|
|
|
26
26
|
}
|
|
27
27
|
exports.Artifact = Artifact;
|
|
28
28
|
_a = JSII_RTTI_SYMBOL_1;
|
|
29
|
-
Artifact[_a] = { fqn: "@flit/cdk-pipeline.Artifact", version: "1.0
|
|
29
|
+
Artifact[_a] = { fqn: "@flit/cdk-pipeline.Artifact", version: "1.1.0" };
|
|
30
30
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWZhY3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvYXJ0aWZhY3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxtRUFBdUU7QUFJdkUsTUFBYSxRQUFTLFNBQVEsMkJBQVc7SUFHdkMsWUFBWSxZQUFxQjtRQUMvQixLQUFLLENBQUMsWUFBWSxDQUFDLENBQUM7UUFGZCxjQUFTLEdBQWMsRUFBRSxDQUFDO0lBR2xDLENBQUM7SUFDRCxPQUFPLENBQUMsUUFBaUI7UUFDdkIsSUFBSSxJQUFJLENBQUMsUUFBUTtZQUFFLE1BQU0sSUFBSSxLQUFLLENBQUMsOEJBQThCLENBQUMsQ0FBQztRQUNuRSxJQUFJLENBQUMsUUFBUSxHQUFHLFFBQVEsQ0FBQztJQUMzQixDQUFDO0lBQ0QsT0FBTyxDQUFDLFFBQWlCO1FBQ3ZCLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ2hDLENBQUM7SUFDRCxjQUFjO1FBQ1osT0FBTyxJQUFJLENBQUMsUUFBUSxDQUFDO0lBQ3ZCLENBQUM7SUFDRCxlQUFlO1FBQ2IsT0FBTyxJQUFJLENBQUMsU0FBUyxDQUFDO0lBQ3hCLENBQUM7O0FBbEJILDRCQW1CQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEFydGlmYWN0IGFzIEF3c0FydGlmYWN0IH0gZnJvbSBcImF3cy1jZGstbGliL2F3cy1jb2RlcGlwZWxpbmVcIjtcblxuaW1wb3J0IHsgU2VnbWVudCB9IGZyb20gXCIuL3NlZ21lbnRcIjtcblxuZXhwb3J0IGNsYXNzIEFydGlmYWN0IGV4dGVuZHMgQXdzQXJ0aWZhY3Qge1xuICBwcml2YXRlIHByb2R1Y2VyPzogU2VnbWVudDtcbiAgcHJpdmF0ZSBjb25zdW1lcnM6IFNlZ21lbnRbXSA9IFtdO1xuICBjb25zdHJ1Y3RvcihhcnRpZmFjdE5hbWU/OiBzdHJpbmcpIHtcbiAgICBzdXBlcihhcnRpZmFjdE5hbWUpO1xuICB9XG4gIHByb2R1Y2UocHJvZHVjZXI6IFNlZ21lbnQpIHtcbiAgICBpZiAodGhpcy5wcm9kdWNlcikgdGhyb3cgbmV3IEVycm9yKFwiQXJ0aWZhY3QgaXMgYWxyZWFkeSBwcm9kdWNlZFwiKTtcbiAgICB0aGlzLnByb2R1Y2VyID0gcHJvZHVjZXI7XG4gIH1cbiAgY29uc3VtZShwcm9kdWNlcjogU2VnbWVudCkge1xuICAgIHRoaXMuY29uc3VtZXJzLnB1c2gocHJvZHVjZXIpO1xuICB9XG4gIG9idGFpblByb2R1Y2VyKCk6IFNlZ21lbnQgfCB1bmRlZmluZWQge1xuICAgIHJldHVybiB0aGlzLnByb2R1Y2VyO1xuICB9XG4gIG9idGFpbkNvbnN1bWVycygpOiBTZWdtZW50W10ge1xuICAgIHJldHVybiB0aGlzLmNvbnN1bWVycztcbiAgfVxufVxuIl19
|
|
@@ -23,7 +23,7 @@ class CodeCommitSourceSegment extends source_segment_1.SourceSegment {
|
|
|
23
23
|
}
|
|
24
24
|
exports.CodeCommitSourceSegment = CodeCommitSourceSegment;
|
|
25
25
|
_a = JSII_RTTI_SYMBOL_1;
|
|
26
|
-
CodeCommitSourceSegment[_a] = { fqn: "@flit/cdk-pipeline.CodeCommitSourceSegment", version: "1.0
|
|
26
|
+
CodeCommitSourceSegment[_a] = { fqn: "@flit/cdk-pipeline.CodeCommitSourceSegment", version: "1.1.0" };
|
|
27
27
|
class CodeCommitSourceSegmentConstructed extends segment_1.SegmentConstructed {
|
|
28
28
|
constructor(scope, id, props) {
|
|
29
29
|
super(scope, id);
|
|
@@ -33,5 +33,5 @@ class CodeCommitSourceSegmentConstructed extends segment_1.SegmentConstructed {
|
|
|
33
33
|
}
|
|
34
34
|
exports.CodeCommitSourceSegmentConstructed = CodeCommitSourceSegmentConstructed;
|
|
35
35
|
_b = JSII_RTTI_SYMBOL_1;
|
|
36
|
-
CodeCommitSourceSegmentConstructed[_b] = { fqn: "@flit/cdk-pipeline.CodeCommitSourceSegmentConstructed", version: "1.0
|
|
36
|
+
CodeCommitSourceSegmentConstructed[_b] = { fqn: "@flit/cdk-pipeline.CodeCommitSourceSegmentConstructed", version: "1.1.0" };
|
|
37
37
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29kZS1jb21taXQtc291cmNlLXNlZ21lbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvY29kZS1jb21taXQtc291cmNlLXNlZ21lbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFDQSxtRkFHOEM7QUFLOUMsdUNBQStDO0FBQy9DLHFEQUFxRTtBQVNyRTs7R0FFRztBQUNILE1BQWEsdUJBQXdCLFNBQVEsOEJBQWE7SUFFeEQsWUFBWSxLQUFtQztRQUM3QyxLQUFLLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDYixJQUFJLENBQUMsS0FBSyxHQUFHLEtBQUssQ0FBQztJQUNyQixDQUFDO0lBQ0QsU0FBUyxDQUFDLEtBQWU7UUFDdkIsT0FBTyxJQUFJLGtDQUFrQyxDQUMzQyxLQUFLLEVBQ0wsSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsY0FBYyxFQUNwQztZQUNFLEdBQUcsSUFBSSxDQUFDLEtBQUs7WUFDYixVQUFVLEVBQUUsSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsY0FBYztTQUNqRCxDQUNGLENBQUM7SUFDSixDQUFDOztBQWZILDBEQWdCQzs7O0FBV0QsTUFBYSxrQ0FBbUMsU0FBUSw0QkFBa0I7SUFHeEUsWUFDRSxLQUFlLEVBQ2YsRUFBVSxFQUNWLEtBQThDO1FBRTlDLEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFDakIsSUFBSSxDQUFDLElBQUksR0FBRyxRQUFRLENBQUM7UUFDckIsSUFBSSxDQUFDLE9BQU8sR0FBRyxDQUFDLElBQUksaURBQXNCLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQztJQUNyRCxDQUFDOztBQVhILGdGQVlDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgSUFjdGlvbiB9IGZyb20gXCJhd3MtY2RrLWxpYi9hd3MtY29kZXBpcGVsaW5lXCI7XG5pbXBvcnQge1xuICBDb2RlQ29tbWl0U291cmNlQWN0aW9uLFxuICBDb2RlQ29tbWl0VHJpZ2dlcixcbn0gZnJvbSBcImF3cy1jZGstbGliL2F3cy1jb2RlcGlwZWxpbmUtYWN0aW9uc1wiO1xuaW1wb3J0IHsgSVJlcG9zaXRvcnkgfSBmcm9tIFwiYXdzLWNkay1saWIvYXdzLWNvZGVjb21taXRcIjtcblxuaW1wb3J0IHsgUGlwZWxpbmUgfSBmcm9tIFwiLi9waXBlbGluZVwiO1xuaW1wb3J0IHsgQXJ0aWZhY3QgfSBmcm9tIFwiLi9hcnRpZmFjdFwiO1xuaW1wb3J0IHsgU2VnbWVudENvbnN0cnVjdGVkIH0gZnJvbSBcIi4vc2VnbWVudFwiO1xuaW1wb3J0IHsgU291cmNlU2VnbWVudCwgU291cmNlU2VnbWVudFByb3BzIH0gZnJvbSBcIi4vc291cmNlLXNlZ21lbnRcIjtcblxuZXhwb3J0IGludGVyZmFjZSBDb2RlQ29tbWl0U291cmNlU2VnbWVudFByb3BzIGV4dGVuZHMgU291cmNlU2VnbWVudFByb3BzIHtcbiAgcmVhZG9ubHkgcmVwb3NpdG9yeTogSVJlcG9zaXRvcnk7XG4gIHJlYWRvbmx5IGJyYW5jaD86IHN0cmluZztcbiAgcmVhZG9ubHkgdHJpZ2dlcj86IENvZGVDb21taXRUcmlnZ2VyO1xuICByZWFkb25seSB2YXJpYWJsZXNOYW1lc3BhY2U/OiBzdHJpbmc7XG59XG5cbi8qKlxuICogQGNhdGVnb3J5IFNlZ21lbnRzXG4gKi9cbmV4cG9ydCBjbGFzcyBDb2RlQ29tbWl0U291cmNlU2VnbWVudCBleHRlbmRzIFNvdXJjZVNlZ21lbnQge1xuICBwcml2YXRlIHByb3BzOiBDb2RlQ29tbWl0U291cmNlU2VnbWVudFByb3BzO1xuICBjb25zdHJ1Y3Rvcihwcm9wczogQ29kZUNvbW1pdFNvdXJjZVNlZ21lbnRQcm9wcykge1xuICAgIHN1cGVyKHByb3BzKTtcbiAgICB0aGlzLnByb3BzID0gcHJvcHM7XG4gIH1cbiAgY29uc3RydWN0KHNjb3BlOiBQaXBlbGluZSk6IFNlZ21lbnRDb25zdHJ1Y3RlZCB7XG4gICAgcmV0dXJuIG5ldyBDb2RlQ29tbWl0U291cmNlU2VnbWVudENvbnN0cnVjdGVkKFxuICAgICAgc2NvcGUsXG4gICAgICB0aGlzLnByb3BzLnJlcG9zaXRvcnkucmVwb3NpdG9yeU5hbWUsXG4gICAgICB7XG4gICAgICAgIC4uLnRoaXMucHJvcHMsXG4gICAgICAgIGFjdGlvbk5hbWU6IHRoaXMucHJvcHMucmVwb3NpdG9yeS5yZXBvc2l0b3J5TmFtZSxcbiAgICAgIH0sXG4gICAgKTtcbiAgfVxufVxuXG5leHBvcnQgaW50ZXJmYWNlIENvZGVDb21taXRTb3VyY2VTZWdtZW50Q29uc3RydWN0ZWRQcm9wcyB7XG4gIHJlYWRvbmx5IG91dHB1dDogQXJ0aWZhY3Q7XG4gIHJlYWRvbmx5IGFjdGlvbk5hbWU6IHN0cmluZztcbiAgcmVhZG9ubHkgcmVwb3NpdG9yeTogSVJlcG9zaXRvcnk7XG4gIHJlYWRvbmx5IGJyYW5jaD86IHN0cmluZztcbiAgcmVhZG9ubHkgdHJpZ2dlcj86IENvZGVDb21taXRUcmlnZ2VyO1xuICByZWFkb25seSB2YXJpYWJsZXNOYW1lc3BhY2U/OiBzdHJpbmc7XG59XG5cbmV4cG9ydCBjbGFzcyBDb2RlQ29tbWl0U291cmNlU2VnbWVudENvbnN0cnVjdGVkIGV4dGVuZHMgU2VnbWVudENvbnN0cnVjdGVkIHtcbiAgcmVhZG9ubHkgbmFtZTogc3RyaW5nO1xuICByZWFkb25seSBhY3Rpb25zOiBJQWN0aW9uW107XG4gIGNvbnN0cnVjdG9yKFxuICAgIHNjb3BlOiBQaXBlbGluZSxcbiAgICBpZDogc3RyaW5nLFxuICAgIHByb3BzOiBDb2RlQ29tbWl0U291cmNlU2VnbWVudENvbnN0cnVjdGVkUHJvcHMsXG4gICkge1xuICAgIHN1cGVyKHNjb3BlLCBpZCk7XG4gICAgdGhpcy5uYW1lID0gXCJTb3VyY2VcIjtcbiAgICB0aGlzLmFjdGlvbnMgPSBbbmV3IENvZGVDb21taXRTb3VyY2VBY3Rpb24ocHJvcHMpXTtcbiAgfVxufVxuIl19
|
|
@@ -24,7 +24,7 @@ class CodeStarSourceSegment extends source_segment_1.SourceSegment {
|
|
|
24
24
|
}
|
|
25
25
|
exports.CodeStarSourceSegment = CodeStarSourceSegment;
|
|
26
26
|
_a = JSII_RTTI_SYMBOL_1;
|
|
27
|
-
CodeStarSourceSegment[_a] = { fqn: "@flit/cdk-pipeline.CodeStarSourceSegment", version: "1.0
|
|
27
|
+
CodeStarSourceSegment[_a] = { fqn: "@flit/cdk-pipeline.CodeStarSourceSegment", version: "1.1.0" };
|
|
28
28
|
class CodeStarSourceSegmentConstructed extends segment_1.SegmentConstructed {
|
|
29
29
|
constructor(scope, id, props) {
|
|
30
30
|
super(scope, id);
|
|
@@ -34,5 +34,5 @@ class CodeStarSourceSegmentConstructed extends segment_1.SegmentConstructed {
|
|
|
34
34
|
}
|
|
35
35
|
exports.CodeStarSourceSegmentConstructed = CodeStarSourceSegmentConstructed;
|
|
36
36
|
_b = JSII_RTTI_SYMBOL_1;
|
|
37
|
-
CodeStarSourceSegmentConstructed[_b] = { fqn: "@flit/cdk-pipeline.CodeStarSourceSegmentConstructed", version: "1.0
|
|
37
|
+
CodeStarSourceSegmentConstructed[_b] = { fqn: "@flit/cdk-pipeline.CodeStarSourceSegmentConstructed", version: "1.1.0" };
|
|
38
38
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29kZS1zdGFyLXNvdXJjZS1zZWdtZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvZGUtc3Rhci1zb3VyY2Utc2VnbWVudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUNBLG1GQUF1RjtBQUl2Rix1Q0FBK0M7QUFDL0MscURBQXFFO0FBV3JFOztHQUVHO0FBQ0gsTUFBYSxxQkFBc0IsU0FBUSw4QkFBYTtJQUV0RCxZQUFZLEtBQWlDO1FBQzNDLEtBQUssQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUNiLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFDO0lBQ3JCLENBQUM7SUFDRCxTQUFTLENBQUMsS0FBZTtRQUN2QixPQUFPLElBQUksZ0NBQWdDLENBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxLQUFLLENBQUMsVUFBVSxFQUFFO1lBQ3hFLEdBQUcsSUFBSSxDQUFDLEtBQUs7WUFDYixVQUFVLEVBQUUsSUFBSSxDQUFDLEtBQUssQ0FBQyxVQUFVO1lBQ2pDLElBQUksRUFBRSxJQUFJLENBQUMsS0FBSyxDQUFDLFVBQVU7U0FDNUIsQ0FBQyxDQUFDO0lBQ0wsQ0FBQzs7QUFaSCxzREFhQzs7O0FBY0QsTUFBYSxnQ0FBaUMsU0FBUSw0QkFBa0I7SUFHdEUsWUFDRSxLQUFlLEVBQ2YsRUFBVSxFQUNWLEtBQTRDO1FBRTVDLEtBQUssQ0FBQyxLQUFLLEVBQUUsRUFBRSxDQUFDLENBQUM7UUFDakIsSUFBSSxDQUFDLElBQUksR0FBRyxRQUFRLENBQUM7UUFDckIsSUFBSSxDQUFDLE9BQU8sR0FBRyxDQUFDLElBQUksMERBQStCLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQztJQUM5RCxDQUFDOztBQVhILDRFQVlDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgSUFjdGlvbiB9IGZyb20gXCJhd3MtY2RrLWxpYi9hd3MtY29kZXBpcGVsaW5lXCI7XG5pbXBvcnQgeyBDb2RlU3RhckNvbm5lY3Rpb25zU291cmNlQWN0aW9uIH0gZnJvbSBcImF3cy1jZGstbGliL2F3cy1jb2RlcGlwZWxpbmUtYWN0aW9uc1wiO1xuXG5pbXBvcnQgeyBQaXBlbGluZSB9IGZyb20gXCIuL3BpcGVsaW5lXCI7XG5pbXBvcnQgeyBBcnRpZmFjdCB9IGZyb20gXCIuL2FydGlmYWN0XCI7XG5pbXBvcnQgeyBTZWdtZW50Q29uc3RydWN0ZWQgfSBmcm9tIFwiLi9zZWdtZW50XCI7XG5pbXBvcnQgeyBTb3VyY2VTZWdtZW50LCBTb3VyY2VTZWdtZW50UHJvcHMgfSBmcm9tIFwiLi9zb3VyY2Utc2VnbWVudFwiO1xuXG5leHBvcnQgaW50ZXJmYWNlIENvZGVTdGFyU291cmNlU2VnbWVudFByb3BzIGV4dGVuZHMgU291cmNlU2VnbWVudFByb3BzIHtcbiAgcmVhZG9ubHkgb3duZXI6IHN0cmluZztcbiAgcmVhZG9ubHkgY29ubmVjdGlvbkFybjogc3RyaW5nO1xuICByZWFkb25seSByZXBvc2l0b3J5OiBzdHJpbmc7XG4gIHJlYWRvbmx5IGJyYW5jaD86IHN0cmluZztcbiAgcmVhZG9ubHkgdHJpZ2dlck9uUHVzaD86IGJvb2xlYW47XG4gIHJlYWRvbmx5IHZhcmlhYmxlc05hbWVzcGFjZT86IHN0cmluZztcbn1cblxuLyoqXG4gKiBAY2F0ZWdvcnkgU2VnbWVudHNcbiAqL1xuZXhwb3J0IGNsYXNzIENvZGVTdGFyU291cmNlU2VnbWVudCBleHRlbmRzIFNvdXJjZVNlZ21lbnQge1xuICBwcml2YXRlIHByb3BzOiBDb2RlU3RhclNvdXJjZVNlZ21lbnRQcm9wcztcbiAgY29uc3RydWN0b3IocHJvcHM6IENvZGVTdGFyU291cmNlU2VnbWVudFByb3BzKSB7XG4gICAgc3VwZXIocHJvcHMpO1xuICAgIHRoaXMucHJvcHMgPSBwcm9wcztcbiAgfVxuICBjb25zdHJ1Y3Qoc2NvcGU6IFBpcGVsaW5lKTogU2VnbWVudENvbnN0cnVjdGVkIHtcbiAgICByZXR1cm4gbmV3IENvZGVTdGFyU291cmNlU2VnbWVudENvbnN0cnVjdGVkKHNjb3BlLCB0aGlzLnByb3BzLnJlcG9zaXRvcnksIHtcbiAgICAgIC4uLnRoaXMucHJvcHMsXG4gICAgICBhY3Rpb25OYW1lOiB0aGlzLnByb3BzLnJlcG9zaXRvcnksXG4gICAgICByZXBvOiB0aGlzLnByb3BzLnJlcG9zaXRvcnksXG4gICAgfSk7XG4gIH1cbn1cblxuZXhwb3J0IGludGVyZmFjZSBDb2RlU3RhclNvdXJjZVNlZ21lbnRDb25zdHJ1Y3RlZFByb3BzIHtcbiAgcmVhZG9ubHkgb3V0cHV0OiBBcnRpZmFjdDtcbiAgcmVhZG9ubHkgYWN0aW9uTmFtZTogc3RyaW5nO1xuICByZWFkb25seSBjb25uZWN0aW9uQXJuOiBzdHJpbmc7XG4gIHJlYWRvbmx5IG93bmVyOiBzdHJpbmc7XG4gIHJlYWRvbmx5IHJlcG86IHN0cmluZztcbiAgcmVhZG9ubHkgYnJhbmNoPzogc3RyaW5nO1xuICByZWFkb25seSBydW5PcmRlcj86IG51bWJlcjtcbiAgcmVhZG9ubHkgdHJpZ2dlck9uUHVzaD86IGJvb2xlYW47XG4gIHJlYWRvbmx5IHZhcmlhYmxlc05hbWVzcGFjZT86IHN0cmluZztcbn1cblxuZXhwb3J0IGNsYXNzIENvZGVTdGFyU291cmNlU2VnbWVudENvbnN0cnVjdGVkIGV4dGVuZHMgU2VnbWVudENvbnN0cnVjdGVkIHtcbiAgcmVhZG9ubHkgbmFtZTogc3RyaW5nO1xuICByZWFkb25seSBhY3Rpb25zOiBJQWN0aW9uW107XG4gIGNvbnN0cnVjdG9yKFxuICAgIHNjb3BlOiBQaXBlbGluZSxcbiAgICBpZDogc3RyaW5nLFxuICAgIHByb3BzOiBDb2RlU3RhclNvdXJjZVNlZ21lbnRDb25zdHJ1Y3RlZFByb3BzLFxuICApIHtcbiAgICBzdXBlcihzY29wZSwgaWQpO1xuICAgIHRoaXMubmFtZSA9IFwiU291cmNlXCI7XG4gICAgdGhpcy5hY3Rpb25zID0gW25ldyBDb2RlU3RhckNvbm5lY3Rpb25zU291cmNlQWN0aW9uKHByb3BzKV07XG4gIH1cbn1cbiJdfQ==
|