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

docs: update CDK example to nodejs18 #1197

Merged
merged 2 commits into from
Dec 19, 2022
Merged

docs: update CDK example to nodejs18 #1197

merged 2 commits into from
Dec 19, 2022

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

Following the merge of #1192, this PR introduces some changes to the CDK examples that are now updated to use the nodejs18x runtime.

The PR also includes other changes that, among other things, partially address the discussion in #520:

  • Removed redundant functions
  • Improved project structure with dedicated functions folder & shared code in functions/common
  • Added API Gateway to align with the SAM
  • Improved README file
  • Removed auto-invoke logic in favor of user/reader invoking functions via API Gw
  • Moved all functions to use Lambda Layers

How to verify this change

See unit tests in the PR that prove that the examples build successfully.

I have also manually deployed & tested the sample in an AWS account and verified that they work as intended.

Related issues, RFCs

Issue number: #520

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi self-assigned this Dec 19, 2022
@pull-request-size pull-request-size bot added the size/XXL PRs with 1K+ LOC, largely documentation related label Dec 19, 2022
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 19, 2022
@dreamorosi dreamorosi merged commit b4cb3d9 into main Dec 19, 2022
@dreamorosi dreamorosi deleted the docs/cdk/nodejs18 branch December 19, 2022 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XXL PRs with 1K+ LOC, largely documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant