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.

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

Prerequisites section should have minimal version of runtimes and tools #682

Closed
rednes opened this issue Sep 8, 2018 · 5 comments
Closed
Assignees
Labels
docs/guide Related to the developer guide effort/small Small work item – less than a day of effort p0 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.

Comments

@rednes
Copy link

rednes commented Sep 8, 2018

https://awslabs.github.io/aws-cdk/getting-started.html

With reference to Getting Started, I tried to make TypeScript's AWS CDK app.
In the Compile the Code section, I got an error when building TypeScript.

https://awslabs.github.io/aws-cdk/getting-started.html#compile-the-code

$ npm run build
'es3', 'es5', 'es6', 'es2015', 'es2016', 'es2017', 'esnext' for tsconfig.json (3,19): error TS 6046: Argument for ' .

In tsconfig.json , target of compilerOptions is set to ES2018.
Therefore, TypeScript needs to be a version supporting ES2018.

ES2018 is supported by TypeScript 2.7.
microsoft/TypeScript#20342

The version of TypeScript installed in my environment is old.

$ tsc -v
Version 2.6.2

It was solved by installing the latest TypeScript and building it.

$ npm install typescript -g
$ tsc -v
Version 3.0.3
$ npm run build

It will help peeple like me that using old version TypeScript mindlessly.

@eladb eladb changed the title Prerequirement section should have minimal version of TypeScript Pre-requirement section should have minimal version of runtimes and tools Nov 29, 2018
@Doug-AWS
Copy link
Contributor

The current "Installing and Configuring the AWS CDK" section, https://docs.aws.amazon.com/CDK/latest/userguide/install_config.html, has the following under "Prerequisites":

You must install Node.js (>= 8.11.x) to use the command-line toolkit and language bindings.

If you use Java, you must set the JAVA_HOME environment variable to the path to where you have installed the JDK on your machine to build an AWS CDK app in Java.

You must specify both your credentials and a region to use the toolkit, as described in Specifying your Credentials.

I'll add the TypeScript info, but who knows the requirements for Java, .NET/C#?

@Doug-AWS Doug-AWS added docs/guide Related to the developer guide p1 effort/small Small work item – less than a day of effort needs-response labels Jan 23, 2019
@Doug-AWS
Copy link
Contributor

Assigning to Mathew as he owns the .NET port.

@Doug-AWS Doug-AWS added pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. and removed needs-response labels Feb 21, 2019
@Doug-AWS Doug-AWS assigned Doug-AWS and unassigned mpiroc Feb 21, 2019
@Doug-AWS Doug-AWS added p0 and removed p1 labels Feb 21, 2019
@Doug-AWS
Copy link
Contributor

Here's what I have:

CLR version >= 4.5

@Doug-AWS Doug-AWS changed the title Pre-requirement section should have minimal version of runtimes and tools Prerequisites section should have minimal version of runtimes and tools Feb 25, 2019
@Doug-AWS
Copy link
Contributor

Doug-AWS commented Mar 4, 2019

From Aaron for C#:

.NET standard 2.0 compatible implementation:

  • .NET Core >= 2.0
  • .NET Framework >= 4.6.1
  • Mono >= 5.4

As soon as I publish the updated doc I will provide the URL here and close this issue.

@Doug-AWS
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs/guide Related to the developer guide effort/small Small work item – less than a day of effort p0 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.
Projects
None yet
Development

No branches or pull requests

4 participants