Skip to content

docs(examples): made SAM CLI version requirement more explicit #1284

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

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

Multiple users #1273 and #1281 reported having issues with the SAM examples in this repo due to the readme file not being explicit about the minimum version required for SAM CLI.

Node.js 18.x support was released in AWS SAM CLI version 1.65, users running a lower version and trying to compile the version run into the following error during compile:

Error: 'nodejs18.x' runtime is not supported

This PR adds a visual callout to the readme that specifies the version and links to instruction on how to upgrade.

How to verify this change

See the updated readme, which looks like the image below (red box added to highlight changes):
Screenshot 2023-02-10 at 19 20 16

Related issues, RFCs

Issue number: #1273

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 Feb 10, 2023
@dreamorosi dreamorosi linked an issue Feb 10, 2023 that may be closed by this pull request
1 task
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Feb 10, 2023
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 10, 2023
@dreamorosi dreamorosi merged commit 6b08fb6 into main Feb 10, 2023
@dreamorosi dreamorosi deleted the 1273-docs-specify-minimum-sam-cli-version-in-examplessam-readme-file branch February 10, 2023 18:27
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/XS PR between 0-9 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: specify minimum SAM CLI version in examples/sam readme file
1 participant