[docs] Install examples use latest version #872
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To avoid confusion, the docs show install examples using the latest ESF version.
There was a problem hiding this comment.
PR Overview
This PR updates the documentation examples for deploying the Elastic Serverless Forwarder to use the latest version, reducing confusion regarding version references.
- Updated install and update commands to use lambda version "v1.19.0" or a placeholder "[new-version]" where applicable.
- Adjusted commands in multiple examples to reflect the new version, ensuring consistency in documentation.
Reviewed Changes
| File | Description |
|---|---|
| docs/reference/aws-deploy-elastic-serverless-forwarder.md | Updated version references in CLI examples to the latest version and replaced outdated version strings with new ones or placeholders. |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
There was a problem hiding this comment.
PR Overview
This PR updates the installation examples for the publish_lambda.sh script to use the latest ESF version, reducing potential confusion.
- Updates version numbers from v1.6.0/v1.7.0 to v1.19.0 or a placeholder for new versions
- Corrects a typo in the bucket name for the second Lambda example
Reviewed Changes
| File | Description |
|---|---|
| docs/reference/aws-deploy-elastic-serverless-forwarder.md | Updated version numbers and fixed a typo in the bucket name |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
docs/reference/aws-deploy-elastic-serverless-forwarder.md:617
- [nitpick] Consider using a consistent version format (e.g., lambda-v1.19.0) instead of the placeholder lambda-v[new-version] to prevent potential confusion for users.
+$ ./publish_lambda.sh publish-config.yaml forwarder-lambda lambda-v[new-version] s3-lambda-artifact-bucket-name eu-central-1
|
Minimum allowed coverage is Generated by 🐒 cobertura-action against c2481e6 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Update the
publish_lambda.shusage example using the latest ESF version.Why is it important?
Avoid the confusion that may come from examples using a two-year-old version.
The
publish_lambda.shscript published the Lambda application to the SAR, so it does not target regular users. However, it can create confusion, so it's worth using the latest version.Checklist
CHANGELOG.mdand updatedshare/version.py, if my change requires a new release.Author's Checklist
How to test this PR locally
Related issues
Use cases
Screenshots
Logs