@cdklabs/cdk-cicd-wrapper 0.0.0 → 0.0.2

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/README.md CHANGED
@@ -1 +1,92 @@
1
- # replace this
1
+ ## CDK CI/CD Wrapper
2
+
3
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
4
+
5
+ The [CDK CI/CD Wrapper](https://cdklabs.github.io/cdk-cicd-wrapper/) is a comprehensive solution that streamlines the delivery of your AWS Cloud Development Kit (CDK) applications. It provides a robust and standardized multi-stage CI/CD pipeline, ensuring high quality and confidence throughout the development and deployment process.
6
+
7
+ ## Table of Contents
8
+
9
+ - [Introduction](#introduction)
10
+ - [Features](#features)
11
+ - [Getting Started](#getting-started)
12
+ - [Prerequisites](#prerequisites)
13
+ - [Installation](#installation)
14
+ - [Usage](#usage)
15
+ - [Defining Stages](#defining-stages)
16
+ - [Configuring Stacks](#configuring-stacks)
17
+ - [Customizing CI/CD Steps](#customizing-cicd-steps)
18
+ - [Contributing](#contributing)
19
+ - [License](#license)
20
+
21
+ ## Introduction
22
+
23
+ The CDK CI/CD Wrapper builds upon the success of the [aws-cdk-cicd-boot-sample](https://github.com/aws-samples/aws-cdk-cicd-boot-sample) and takes it a step further by providing additional tools and features to simplify and standardize the multi-stage CI/CD process for your Infrastructure as Code (IaC) projects.
24
+
25
+ ## Features
26
+
27
+ - **Multi-staged CI/CD Pipeline**: Seamlessly deploy your CDK applications across multiple stages (e.g., DEV, INT, PROD) and AWS accounts.
28
+ - **Security Scanning**: Perform security scanning on dependencies and codebase, blocking the pipeline in case of CVE findings.
29
+ - **License Management**: Manage licenses for NPM and Python dependencies, ensuring compliance with your organization's policies.
30
+ - **Private NPM Registry**: Securely store and utilize private NPM libraries.
31
+ - **Customizable Pipeline**: Tailor the CI/CD pipeline to your project's specific needs with built-in dependency injection.
32
+ - **Workbench Deployment**: Develop and experiment with your solutions in isolation before introducing them to the delivery pipeline.
33
+ - **Pre/Post Deploy Hooks**: Execute custom scripts before and after deployments in each stage (e.g., unit tests, functional tests, load testing).
34
+ - **Centralized Compliance Logs**: Store compliance logs in pre-configured S3 buckets on a per-stage/environment basis.
35
+ - **Lambda Layer Support**: Build and scan dependencies for Python Lambda Layers.
36
+
37
+ ## Getting Started
38
+
39
+ ### Prerequisites
40
+
41
+ Before you begin, ensure that you have the following dependencies installed:
42
+
43
+ - AWS Account (RES/DEV/INT/PROD)
44
+ - macOS or Cloud9 with Ubuntu Server 22.04 LTS Platform in the RES Account
45
+ - Bash/ZSH terminal
46
+ - Docker version >= 24.0.x
47
+ - AWS CLI v2 ([installation guide](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html))
48
+ - AWS credentials and profiles for each environment in `~/.aws/config` ([configuration guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html))
49
+ - Node.js >= v18.17._ && NPM >= v10.2._
50
+ - jq command-line JSON processor (jq-1.5)
51
+
52
+ For developing Python Lambdas, you'll also need:
53
+
54
+ - Python >= 3.11
55
+ - Pipenv 2023.* ([installation guide](https://pipenv.pypa.io/en/latest/))
56
+
57
+ ### Installation
58
+
59
+ 1. Clone the CDK CI/CD Wrapper repository:
60
+
61
+ ```bash
62
+ git clone https://github.com/your-repo/cdk-cicd-wrapper.git
63
+ cd cdk-cicd-wrapper
64
+ ```
65
+
66
+ 2. Install the required dependencies:
67
+
68
+ ```bash
69
+ npm install
70
+ ```
71
+
72
+ ## Usage
73
+
74
+ ### Defining Stages
75
+
76
+ The CDK CI/CD Wrapper comes with a default set of stages (DEV, INT, PROD), but you can easily extend or modify these stages to suit your project's needs. Follow the step-by-step guide in the documentation to define your desired stages.
77
+
78
+ ### Configuring Stacks
79
+
80
+ Configure the CDK stacks you want to deploy in each stage. The CDK CI/CD Wrapper allows you to specify which stacks should be deployed in each stage, giving you granular control over your deployment process.
81
+
82
+ ### Customizing CI/CD Steps
83
+
84
+ Tailor the CI/CD pipeline to meet your project's specific requirements. The CDK CI/CD Wrapper provides built-in dependency injection, allowing you to customize the CI/CD steps seamlessly.
85
+
86
+ ## Contributing
87
+
88
+ Contributions to the CDK CI/CD Wrapper are welcome! If you'd like to contribute, please follow the guidelines outlined in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
89
+
90
+ ## License
91
+
92
+ This project is licensed under the [Apache 2.0 License](LICENSE).
package/lib/index.d.ts CHANGED
@@ -7,4 +7,3 @@ export * from './resource-providers';
7
7
  export * from './code-pipeline';
8
8
  export * from './stacks';
9
9
  export * from './utils';
10
- export * from './projen';
package/lib/index.js CHANGED
@@ -31,6 +31,4 @@ __exportStar(require("./code-pipeline"), exports);
31
31
  __exportStar(require("./stacks"), exports);
32
32
  // Exporting all exports from the './utils' file
33
33
  __exportStar(require("./utils"), exports);
34
- // Exporting all exports from the './projen' file
35
- __exportStar(require("./projen"), exports);
36
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHFFQUFxRTtBQUNyRSxzQ0FBc0M7Ozs7Ozs7Ozs7Ozs7Ozs7QUFFdEM7O0dBRUc7QUFFSCxpREFBaUQ7QUFDakQsMkNBQXlCO0FBRXpCLHFEQUFxRDtBQUNyRCwrQ0FBNkI7QUFFN0IsNkRBQTZEO0FBQzdELHVEQUFxQztBQUVyQyx3REFBd0Q7QUFDeEQsa0RBQWdDO0FBRWhDLGlEQUFpRDtBQUNqRCwyQ0FBeUI7QUFFekIsZ0RBQWdEO0FBQ2hELDBDQUF3QjtBQUV4QixpREFBaUQ7QUFDakQsMkNBQXlCIiwic291cmNlc0NvbnRlbnQiOlsiLy8gQ29weXJpZ2h0IEFtYXpvbi5jb20sIEluYy4gb3IgaXRzIGFmZmlsaWF0ZXMuIEFsbCBSaWdodHMgUmVzZXJ2ZWQuXG4vLyBTUERYLUxpY2Vuc2UtSWRlbnRpZmllcjogQXBhY2hlLTIuMFxuXG4vKipcbiAqIFRoaXMgZmlsZSBleHBvcnRzIHZhcmlvdXMgbW9kdWxlcyBmcm9tIG90aGVyIGZpbGVzIHdpdGhpbiB0aGUgcHJvamVjdC5cbiAqL1xuXG4vLyBFeHBvcnRpbmcgYWxsIGV4cG9ydHMgZnJvbSB0aGUgJy4vY29tbW9uJyBmaWxlXG5leHBvcnQgKiBmcm9tICcuL2NvbW1vbic7XG5cbi8vIEV4cG9ydGluZyBhbGwgZXhwb3J0cyBmcm9tIHRoZSAnLi9jb25zdHJ1Y3RzJyBmaWxlXG5leHBvcnQgKiBmcm9tICcuL2NvbnN0cnVjdHMnO1xuXG4vLyBFeHBvcnRpbmcgYWxsIGV4cG9ydHMgZnJvbSB0aGUgJy4vcmVzb3VyY2UtcHJvdmlkZXJzJyBmaWxlXG5leHBvcnQgKiBmcm9tICcuL3Jlc291cmNlLXByb3ZpZGVycyc7XG5cbi8vIEV4cG9ydGluZyBhbGwgZXhwb3J0cyBmcm9tIHRoZSAnLi9jb2RlLXBpcGVsaW5lJyBmaWxlXG5leHBvcnQgKiBmcm9tICcuL2NvZGUtcGlwZWxpbmUnO1xuXG4vLyBFeHBvcnRpbmcgYWxsIGV4cG9ydHMgZnJvbSB0aGUgJy4vc3RhY2tzJyBmaWxlXG5leHBvcnQgKiBmcm9tICcuL3N0YWNrcyc7XG5cbi8vIEV4cG9ydGluZyBhbGwgZXhwb3J0cyBmcm9tIHRoZSAnLi91dGlscycgZmlsZVxuZXhwb3J0ICogZnJvbSAnLi91dGlscyc7XG5cbi8vIEV4cG9ydGluZyBhbGwgZXhwb3J0cyBmcm9tIHRoZSAnLi9wcm9qZW4nIGZpbGVcbmV4cG9ydCAqIGZyb20gJy4vcHJvamVuJztcbiJdfQ==
34
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHFFQUFxRTtBQUNyRSxzQ0FBc0M7Ozs7Ozs7Ozs7Ozs7Ozs7QUFFdEM7O0dBRUc7QUFFSCxpREFBaUQ7QUFDakQsMkNBQXlCO0FBRXpCLHFEQUFxRDtBQUNyRCwrQ0FBNkI7QUFFN0IsNkRBQTZEO0FBQzdELHVEQUFxQztBQUVyQyx3REFBd0Q7QUFDeEQsa0RBQWdDO0FBRWhDLGlEQUFpRDtBQUNqRCwyQ0FBeUI7QUFFekIsZ0RBQWdEO0FBQ2hELDBDQUF3QiIsInNvdXJjZXNDb250ZW50IjpbIi8vIENvcHlyaWdodCBBbWF6b24uY29tLCBJbmMuIG9yIGl0cyBhZmZpbGlhdGVzLiBBbGwgUmlnaHRzIFJlc2VydmVkLlxuLy8gU1BEWC1MaWNlbnNlLUlkZW50aWZpZXI6IEFwYWNoZS0yLjBcblxuLyoqXG4gKiBUaGlzIGZpbGUgZXhwb3J0cyB2YXJpb3VzIG1vZHVsZXMgZnJvbSBvdGhlciBmaWxlcyB3aXRoaW4gdGhlIHByb2plY3QuXG4gKi9cblxuLy8gRXhwb3J0aW5nIGFsbCBleHBvcnRzIGZyb20gdGhlICcuL2NvbW1vbicgZmlsZVxuZXhwb3J0ICogZnJvbSAnLi9jb21tb24nO1xuXG4vLyBFeHBvcnRpbmcgYWxsIGV4cG9ydHMgZnJvbSB0aGUgJy4vY29uc3RydWN0cycgZmlsZVxuZXhwb3J0ICogZnJvbSAnLi9jb25zdHJ1Y3RzJztcblxuLy8gRXhwb3J0aW5nIGFsbCBleHBvcnRzIGZyb20gdGhlICcuL3Jlc291cmNlLXByb3ZpZGVycycgZmlsZVxuZXhwb3J0ICogZnJvbSAnLi9yZXNvdXJjZS1wcm92aWRlcnMnO1xuXG4vLyBFeHBvcnRpbmcgYWxsIGV4cG9ydHMgZnJvbSB0aGUgJy4vY29kZS1waXBlbGluZScgZmlsZVxuZXhwb3J0ICogZnJvbSAnLi9jb2RlLXBpcGVsaW5lJztcblxuLy8gRXhwb3J0aW5nIGFsbCBleHBvcnRzIGZyb20gdGhlICcuL3N0YWNrcycgZmlsZVxuZXhwb3J0ICogZnJvbSAnLi9zdGFja3MnO1xuXG4vLyBFeHBvcnRpbmcgYWxsIGV4cG9ydHMgZnJvbSB0aGUgJy4vdXRpbHMnIGZpbGVcbmV4cG9ydCAqIGZyb20gJy4vdXRpbHMnO1xuIl19
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cdklabs/cdk-cicd-wrapper",
3
- "description": "This repository contains the infrastructure as code to bootstrap your next CI/CD project.",
3
+ "description": "This repository contains the infrastructure as code to wrap your AWS CDK project with CI/CD around it.",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/cdklabs/cdk-cicd-wrapper.git",
@@ -29,8 +29,8 @@
29
29
  "@typescript-eslint/eslint-plugin": "^7",
30
30
  "@typescript-eslint/parser": "^7",
31
31
  "@typescript-eslint/typescript-estree": "^7",
32
- "aws-cdk-lib": "2.139.1",
33
- "cdk-nag": "2.28.109",
32
+ "aws-cdk-lib": "2.140.0",
33
+ "cdk-nag": "2.28.111",
34
34
  "constructs": "^10.3.0",
35
35
  "copyfiles": "^2.4.1",
36
36
  "eslint": "^8",
@@ -41,13 +41,13 @@
41
41
  "jest": "^29.7.0",
42
42
  "jest-junit": "^15",
43
43
  "prettier": "^3.2.5",
44
- "projen": "^0.81.7",
44
+ "projen": "^0.81.8",
45
45
  "ts-jest": "^29.1.2",
46
46
  "typescript": "^5.4.5"
47
47
  },
48
48
  "peerDependencies": {
49
49
  "aws-cdk-lib": "^2.140.0",
50
- "cdk-nag": "^2.28.106",
50
+ "cdk-nag": "^2.28.111",
51
51
  "constructs": "^10.3.0"
52
52
  },
53
53
  "dependencies": {
@@ -62,15 +62,17 @@
62
62
  "aws",
63
63
  "aws-cdk",
64
64
  "awscdk",
65
- "cdk",
66
- "ci-cd-boot"
65
+ "ci-cd",
66
+ "ci-cd-boot",
67
+ "cli",
68
+ "vanilla-pipeline"
67
69
  ],
68
70
  "main": "lib/index.js",
69
71
  "license": "Apache-2.0",
70
72
  "publishConfig": {
71
73
  "access": "public"
72
74
  },
73
- "version": "0.0.0",
75
+ "version": "0.0.2",
74
76
  "jest": {
75
77
  "testMatch": [
76
78
  "<rootDir>/src/**/__tests__/**/*.ts?(x)",