Skip to content

Docs: specify minimum SAM CLI version in examples/sam readme file #1273

Closed
@dreamorosi

Description

@dreamorosi

What were you searching in the docs?

@shdq was trying to deploy the SAM examples and ran into issues around the version of the CLI required to run the example.

The SAM examples using nodejs18.x runtime, this version was introduced in v1.65.0 (source), so users running earlier versions will get a Runtime not supported error.

Is this related to an existing documentation section?

No response

How can we improve?

The README file of the example should have a section that specifies the minimum version required to run the sample.

Got a suggestion in mind?

Add the following wording:

AWS SAM CLI version 1.65 or later. If you have an older version of the AWS SAM CLI, see Upgrading the AWS SAM CLI.

To this section of the readme.

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.

Metadata

Metadata

Assignees

Labels

completedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions