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

fix(aws-cdk): Java init template works on Windows #1503

Merged
merged 1 commit into from
Jan 15, 2019

Conversation

costleya
Copy link
Contributor

@costleya costleya commented Jan 9, 2019


Pull Request Checklist

  • Testing
    • Unit test added
    • CLI change?: manually run integration tests and paste output as a PR comment
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

@costleya costleya requested a review from a team as a code owner January 9, 2019 04:11
Copy link
Contributor

@eladb eladb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also submit an PR with an update to the tutorial in the user guide to reflect this change

Copy @Doug-AWS

@costleya
Copy link
Contributor Author

No updates in the user guide should be required for java. It just changes what "app" cdk runs when you invoke a CLI command.

However, it could be made more clear that you don't necessarily need to do compile after every step, since now synth does that automatically if it needs to. This is similar to the way the getting started for .NET cdk.json works.

The new user guide is incorrect about C# though, since the init code and the instructions I wrote for the getting started (which assumes you are creating from scratch) differ. The init template for .NET needs to be updated to match the assumptions in this new doc.

@costleya
Copy link
Contributor Author

I ran pkglint fix, which changed a lot of files...

How do you want me to handle this?

@eladb
Copy link
Contributor

eladb commented Jan 10, 2019

Would be nice if the getting started guide for java will use the same approach as the new init template. It seems like it still uses the classpath approach

Regarding pkglint : Merge from master you should be fine.

@rix0rrr rix0rrr merged commit 24f521a into aws:master Jan 15, 2019
@Doug-AWS
Copy link
Contributor

There is no "Getting Started" topic in the CDK User Guide on docs.aws.amazon.com. I replaced it by creating an "Installing and Configuring the AWS CDK" topic, and moved the examples of creating a simple CDK app into the next section, "Tutorial", which only uses cdk init ... to create the initial app. I'll make a run through the Java and DotNet/C# sections with the latest bits to ensure they are correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants