Skip to content

docs: update sam example to nodejs18 #1196

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

Merged
merged 1 commit into from
Dec 19, 2022
Merged

docs: update sam example to nodejs18 #1196

merged 1 commit into from
Dec 19, 2022

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

As detailed in #1195, the SAM Examples in the repo needed some changes to start using Node.js 18.

This PR builds upon the changes #1180 and:

  • Sets functions runtime to nodejs18x
  • Updates bundling configs to exclude @aws-sdk/* packages (they're now part of the runtime)
  • Moves functions code back to the folder (symlinks were not working well with jest)
  • Light updates to function's code & dependencies
  • Light updates to README file

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: #1195

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/L PRs between 100-499 LOC label Dec 19, 2022
@dreamorosi dreamorosi linked an issue Dec 19, 2022 that may be closed by this pull request
1 task
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 19, 2022
@dreamorosi dreamorosi merged commit a4134c4 into main Dec 19, 2022
@dreamorosi dreamorosi deleted the docs/sam/nodejs18 branch December 19, 2022 15:58
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/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Move SAM examples to Node18
1 participant