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

feat(aws-cdk) use ts-node for TypeScript app template #2527

Merged
merged 2 commits into from
May 14, 2019

Conversation

mitchlloyd
Copy link
Contributor

@mitchlloyd mitchlloyd commented May 11, 2019

Closes #1532


Pull Request Checklist

  • Testing
    • cdk-init template change?: YES coordinated update of integration tests with team
      • My hunch is that that integration tests will continue to work since npm run build shouldn't hurt anything. However it may be possible to omit this build command.
    • Also ran my own manual test:
      • cd packages/aws-cdk/
      • mkdir foo && cd foo
      • ../bin/cdk init app --language=typescript
      • cdk synth # Resources: {}
      • cdk list # FooStack
  • Docs
    • Public docs need to remove references to npm run build which is no longer required.
  • Title and Description
    • Change type: title prefixed with fix, feat and module name in parens, which 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)
    • NA

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

@mitchlloyd mitchlloyd requested a review from a team as a code owner May 11, 2019 21:49
@mitchlloyd mitchlloyd changed the title feat(aws-cdk) Use ts-node for TypeScript app template feat(aws-cdk) use ts-node for TypeScript app template May 11, 2019
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.

This is cool!

  1. Can you also please update the sample-app template
  2. We need to update related documentation like getting started, READMEs, integ tests. Having said that, this is backwards compatible, so I guess we can do those after this is merged.

@rix0rrr any thoughts on this? Objections?

@mitchlloyd
Copy link
Contributor Author

@eladb Updated sample app as well.

It's a shame that the documentation is no longer accessible via Github... or is it? Would be great to clean up typos and target areas that need a bit of attention.

@eladb
Copy link
Contributor

eladb commented May 14, 2019

It's a shame that the documentation is no longer accessible via Github... or is it? Would be great to clean up typos and target areas that need a bit of attention.

They will eventually be available on GitHub. They are currently going through a reorganization...

@eladb eladb merged commit 4f7b48d into aws:master May 14, 2019
@Doug-AWS
Copy link
Contributor

FYI: Every page in the developer guide, https://docs.aws.amazon.com/cdk/latest/guide, has a link to the GitHub repo (https://github.com/awsdocs/aws-cdk-guide, the doc source is in doc_source) where the Markdown (.md) version of the topic is available for PRs. See the black-and-white cat icon on the top of the page.

As Elad said, we are still making changes to the docs, so sometimes the GitHub repo lags the current dev guide contents for a bit. Feel free to file an issue if you run into any problems. Just tag it with "guide" so I see it.

@mitchlloyd
Copy link
Contributor Author

mitchlloyd commented May 14, 2019 via email

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.

Feature Request: Use ts-node rather than npm watch for boilerplate
3 participants