v0.7.0 (aws#97)

* Bring in historical changelog and add a section for 0.7.0 * Update README instructions * Fix typescript templates
jonife · Jun 13, 2018 · 5a0418a · 5a0418a
1 parent c96511a
commit 5a0418a
Show file tree

Hide file tree

Showing 44 changed files with 1,190 additions and 303 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -5,51 +5,70 @@ for defining cloud infrastructure in code.
 
 ## Getting Started
 
-### Installation
+### Prerequisites
+
+Make sure you have the following prerequisites installed:
 
-Make sure you have the required dependencies installed:
 * [Node.js 8.11.0](https://nodejs.org/download/release/v8.11.0/)
-* The SDK for the language you intend to use (Java, .Net, Ruby, ...)
+* [AWS CLI](https://aws.amazon.com/cli/) (only needed if you intend to download the release from S3).
+* The development toolchain of the language you intend to use (TypeScript,
+  Python, Java, .NET, Ruby...)
+
+### Downloading the bits
+
+The CDK is distributed as a single zip file which contains:
+
+1. The CDK command-line toolkit
+2. Documentation HTML
+2. JavaScript/TypeScript Framework and AWS Constructs
+3. Java Framework and AWS Constructs
+
+You can either download the zip file from the
+[Releases](http://github.com/awslabs/aws-cdk/releases) page on GitHub or if you
+prefer, download them bits from S3 using the URL provided by our team.
+
+To download from S3:
 
-Download the current release bundle from S3, and install it to `~/.cdk`:
 ```shell
-tmpdir=/tmp/aws-cdk-install
-mkdir ${tmpdir}
-aws s3 cp s3://<bucket>/<key> ${tmpdir}/aws-cdk.zip
-unzip -o ${tmpdir}/aws-cdk.zip -d ~/.cdk
+aws s3 cp <s3-url> ~/aws-cdk.zip
 ```
 
-Then add the CDK to your `$PATH`:
+### Install to ~/.cdk
+
+Once you've downloaded the bits, install them into `~/.cdk`:
+
 ```shell
-# At the end of your ~/.bashrc or ~/.zshrc file
-export PATH=${PATH:+${PATH}:}${HOME}/.cdk/bin
+rm -fr ~/.cdk
+mkdir ~/.cdk
+unzip <path-to-zip-file> -d ~/.cdk
 ```
 
-### Creating a new project
+Make sure the ~/.cdk/bin is in your `PATH`
 
-New projects can be initialized using `cdk init`.
 ```shell
-mkdir ${PROJECT_NAME}
-cd ${PROJECT_NAME}
-cdk init
+# at the end of your ~/.bashrc or ~/.zshrc file
+export PATH=$PATH:$HOME/.cdk/bin
 ```
 
-### Useful commands
+To check which CDK version you have installed:
 
 ```shell
-# Initialize a new CDK project
-cdk init
+cdk --version
+```
 
-# Open the documentation in a web browser
-cdk docs
+### Viewing Documentation
 
-# List available commands
-cdk help
+To view CDK documentation bundled with the release, run:
 
-# Get help on a particular command (e.g: synth)
-cdk help synth
+```shell
+cdk docs
 ```
 
+### Next steps?
+
+Follow the "Getting Started" guide in CDK docs to initialize your first CDK
+project and deploy it to an AWS account.
+
 ## Development Environment
 
 This is a monorepo which uses [lerna](https://github.com/lerna/lerna).

diff --git a/examples/package.json b/examples/package.json
@@ -1,6 +1,6 @@
 {
   "name": "examples",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "A bunch of CDK examples",
   "private": true,
   "scripts": {
@@ -17,22 +17,22 @@
   },
   "license": "LicenseRef-LICENSE",
   "devDependencies": {
-    "aws-cdk": "^0.6.0",
-    "pkglint": "^0.6.0"
+    "aws-cdk": "^0.7.0",
+    "pkglint": "^0.7.0"
   },
   "dependencies": {
-    "@aws-cdk/core": "^0.6.0",
-    "@aws-cdk/dynamodb": "^0.6.0",
-    "@aws-cdk/ec2": "^0.6.0",
-    "@aws-cdk/iam": "^0.6.0",
-    "@aws-cdk/lambda": "^0.6.0",
-    "@aws-cdk/neptune": "^0.6.0",
-    "@aws-cdk/rds": "^0.6.0",
-    "@aws-cdk/resources": "^0.6.0",
-    "@aws-cdk/rtv": "^0.6.0",
-    "@aws-cdk/s3": "^0.6.0",
-    "@aws-cdk/sns": "^0.6.0",
-    "@aws-cdk/sqs": "^0.6.0"
+    "@aws-cdk/core": "^0.7.0",
+    "@aws-cdk/dynamodb": "^0.7.0",
+    "@aws-cdk/ec2": "^0.7.0",
+    "@aws-cdk/iam": "^0.7.0",
+    "@aws-cdk/lambda": "^0.7.0",
+    "@aws-cdk/neptune": "^0.7.0",
+    "@aws-cdk/rds": "^0.7.0",
+    "@aws-cdk/resources": "^0.7.0",
+    "@aws-cdk/rtv": "^0.7.0",
+    "@aws-cdk/s3": "^0.7.0",
+    "@aws-cdk/sns": "^0.7.0",
+    "@aws-cdk/sqs": "^0.7.0"
   },
   "repository": {
     "url": "git://github.com/awslabs/aws-cdk",

diff --git a/install.sh b/install.sh
@@ -1,9 +1,6 @@
 #!/bin/bash
 set -euo pipefail
 
-mkdir -p .local-npm
-(cd .local-npm && unzip ../vendor/*.zip)
-
 echo "============================================================================================="
 echo "installing repo-global dependencies..."
 npm i --no-package-lock --global-style
diff --git a/lerna.json b/lerna.json
@@ -7,5 +7,5 @@
     "examples"
   ],
   "rejectCycles": "true",
-  "version": "0.6.0"
+  "version": "0.7.0"
 }
diff --git a/package.json b/package.json
@@ -4,6 +4,7 @@
     "ignore": true
   },
   "scripts": {
+    "preinstall": "rm -fr .local-npm && mkdir -p .local-npm && (cd .local-npm && unzip ../vendor/*.zip)",
     "pkglint": "tools/pkglint/bin/pkglint -f ."
   },
   "devDependencies": {

diff --git a/packages/@aws-cdk/acm/package.json b/packages/@aws-cdk/acm/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@aws-cdk/acm",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "CDK Constructs for AWS ACM",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -35,14 +35,14 @@
   },
   "license": "LicenseRef-LICENSE",
   "devDependencies": {
-    "@aws-cdk/assert": "^0.6.0",
-    "aws-cdk": "^0.6.0",
+    "@aws-cdk/assert": "^0.7.0",
+    "aws-cdk": "^0.7.0",
     "aws-sdk": "^2.135.0",
-    "pkglint": "^0.6.0"
+    "pkglint": "^0.7.0"
   },
   "dependencies": {
-    "@aws-cdk/core": "^0.6.0",
-    "@aws-cdk/iam": "^0.6.0",
-    "@aws-cdk/resources": "^0.6.0"
+    "@aws-cdk/core": "^0.7.0",
+    "@aws-cdk/iam": "^0.7.0",
+    "@aws-cdk/resources": "^0.7.0"
   }
 }
diff --git a/packages/@aws-cdk/applet-js/package.json b/packages/@aws-cdk/applet-js/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@aws-cdk/applet-js",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Javascript CDK applet host program",
   "main": "bin/cdk-applet-js.js",
   "types": "bin/cdk-applet-js.d.ts",
@@ -21,10 +21,10 @@
   "license": "LicenseRef-LICENSE",
   "devDependencies": {
     "@types/yamljs": "^0.2.0",
-    "pkglint": "^0.6.0"
+    "pkglint": "^0.7.0"
   },
   "dependencies": {
-    "@aws-cdk/core": "^0.6.0",
+    "@aws-cdk/core": "^0.7.0",
     "source-map-support": "^0.5.6",
     "yamljs": "^0.2.0"
   },

diff --git a/packages/@aws-cdk/assert/package.json b/packages/@aws-cdk/assert/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@aws-cdk/assert",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "An assertion library for use with CDK Apps",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -21,12 +21,12 @@
   },
   "license": "LicenseRef-LICENSE",
   "devDependencies": {
-    "pkglint": "^0.6.0"
+    "pkglint": "^0.7.0"
   },
   "dependencies": {
-    "@aws-cdk/core": "^0.6.0",
-    "@aws-cdk/cloudformation-diff": "^0.6.0",
-    "@aws-cdk/cx-api": "^0.6.0",
+    "@aws-cdk/cloudformation-diff": "^0.7.0",
+    "@aws-cdk/core": "^0.7.0",
+    "@aws-cdk/cx-api": "^0.7.0",
     "source-map-support": "^0.5.6"
   },
   "repository": {

diff --git a/packages/@aws-cdk/cloudformation-diff/package.json b/packages/@aws-cdk/cloudformation-diff/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@aws-cdk/cloudformation-diff",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Utilities to diff CDK stacks against CloudFormation templates",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -17,10 +17,10 @@
   },
   "license": "LicenseRef-LICENSE",
   "devDependencies": {
-    "pkglint": "^0.6.0"
+    "pkglint": "^0.7.0"
   },
   "dependencies": {
-    "@aws-cdk/resources": "^0.6.0",
+    "@aws-cdk/resources": "^0.7.0",
     "colors": "^1.2.1",
     "source-map-support": "^0.5.6"
   },

diff --git a/packages/@aws-cdk/cloudfront/package.json b/packages/@aws-cdk/cloudfront/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@aws-cdk/cloudfront",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "CDK Constructs for AWS CloudFront",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -35,17 +35,17 @@
   },
   "license": "LicenseRef-LICENSE",
   "devDependencies": {
-    "@aws-cdk/assert": "^0.6.0",
-    "aws-cdk": "^0.6.0",
+    "@aws-cdk/assert": "^0.7.0",
+    "aws-cdk": "^0.7.0",
     "aws-sdk": "^2.135.0",
-    "pkglint": "^0.6.0"
+    "pkglint": "^0.7.0"
   },
   "dependencies": {
-    "@aws-cdk/core": "^0.6.0",
-    "@aws-cdk/iam": "^0.6.0",
-    "@aws-cdk/kms": "^0.6.0",
-    "@aws-cdk/resources": "^0.6.0",
-    "@aws-cdk/s3": "^0.6.0",
-    "@aws-cdk/acm": "^0.6.0"
+    "@aws-cdk/acm": "^0.7.0",
+    "@aws-cdk/core": "^0.7.0",
+    "@aws-cdk/iam": "^0.7.0",
+    "@aws-cdk/kms": "^0.7.0",
+    "@aws-cdk/resources": "^0.7.0",
+    "@aws-cdk/s3": "^0.7.0"
   }
 }
diff --git a/packages/@aws-cdk/cloudtrail/package.json b/packages/@aws-cdk/cloudtrail/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@aws-cdk/cloudtrail",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "CDK Constructs for AWS CloudTrail",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -35,17 +35,17 @@
   },
   "license": "LicenseRef-LICENSE",
   "devDependencies": {
-    "@aws-cdk/assert": "^0.6.0",
-    "aws-cdk": "^0.6.0",
+    "@aws-cdk/assert": "^0.7.0",
+    "aws-cdk": "^0.7.0",
     "aws-sdk": "^2.135.0",
     "colors": "^1.2.1",
-    "pkglint": "^0.6.0"
+    "pkglint": "^0.7.0"
   },
   "dependencies": {
-    "@aws-cdk/core": "^0.6.0",
-    "@aws-cdk/iam": "^0.6.0",
-    "@aws-cdk/kms": "^0.6.0",
-    "@aws-cdk/resources": "^0.6.0",
-    "@aws-cdk/s3": "^0.6.0"
+    "@aws-cdk/core": "^0.7.0",
+    "@aws-cdk/iam": "^0.7.0",
+    "@aws-cdk/kms": "^0.7.0",
+    "@aws-cdk/resources": "^0.7.0",
+    "@aws-cdk/s3": "^0.7.0"
   }
 }
diff --git a/packages/@aws-cdk/codebuild/package.json b/packages/@aws-cdk/codebuild/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@aws-cdk/codebuild",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "CDK Constructs for AWS CodeBuild",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -36,19 +36,19 @@
   },
   "license": "LicenseRef-LICENSE",
   "devDependencies": {
-    "@aws-cdk/assert": "^0.6.0",
-    "@aws-cdk/sns": "^0.6.0",
-    "aws-cdk": "^0.6.0",
+    "@aws-cdk/assert": "^0.7.0",
+    "@aws-cdk/sns": "^0.7.0",
+    "aws-cdk": "^0.7.0",
     "aws-sdk": "^2.135.0",
-    "pkglint": "^0.6.0"
+    "pkglint": "^0.7.0"
   },
   "dependencies": {
-    "@aws-cdk/core": "^0.6.0",
-    "@aws-cdk/codecommit": "^0.6.0",
-    "@aws-cdk/events": "^0.6.0",
-    "@aws-cdk/iam": "^0.6.0",
-    "@aws-cdk/kms": "^0.6.0",
-    "@aws-cdk/resources": "^0.6.0",
-    "@aws-cdk/s3": "^0.6.0"
+    "@aws-cdk/codecommit": "^0.7.0",
+    "@aws-cdk/core": "^0.7.0",
+    "@aws-cdk/events": "^0.7.0",
+    "@aws-cdk/iam": "^0.7.0",
+    "@aws-cdk/kms": "^0.7.0",
+    "@aws-cdk/resources": "^0.7.0",
+    "@aws-cdk/s3": "^0.7.0"
   }
 }