Conversation
Co-authored-by: Copilot <copilot@github.com>
There was a problem hiding this comment.
Pull request overview
Updates the action documentation to include previously undocumented AWS SAM-related inputs, aligning README usage docs more closely with the action’s declared interface.
Changes:
- Document
template_fileinput for SAM template path. - Document
packaged_template_fileinput for the packaged SAM template path.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `use_aws_sam` (optional): Boolean to determine if SAM artifact should be uploaded. | ||
| - `aws_account_region` (optional): AWS region to use for SAM packaging. | ||
| - `template_file` (optional): Path to SAM template file. | ||
| - `packaged_template_file` (optional): Path to packaged SAM template file. |
There was a problem hiding this comment.
The README Outputs section still doesn’t document the packaged-template output that is defined in action.yaml. Since this PR is about adding missing docs, please add that output to README to keep docs consistent with the action interface.
| @@ -20,6 +20,8 @@ See below for inputs, outputs, and examples. | |||
| - `artifact_retention_days` (optional): Number of days to retain artifacts.. | |||
There was a problem hiding this comment.
There’s an extra period at the end of this sentence (“artifacts..”). Please remove the duplicate punctuation to avoid a typo in the inputs documentation.
| - `artifact_retention_days` (optional): Number of days to retain artifacts.. | |
| - `artifact_retention_days` (optional): Number of days to retain artifacts. |
| - `aws_account_region` (optional): AWS region to use for SAM packaging. | ||
| - `template_file` (optional): Path to SAM template file. | ||
| - `packaged_template_file` (optional): Path to packaged SAM template file. | ||
| - `sam_s3_bucket` (optional): S3 bucket for SAM deployment. | ||
| - `sam_s3_prefix` (optional): S3 prefix for SAM deployment. |
There was a problem hiding this comment.
These inputs are only used when use_aws_sam is true (the composite step references them only in that conditional branch). Consider clarifying that in the descriptions so users don’t think they matter for the non-SAM path.
| - `aws_account_region` (optional): AWS region to use for SAM packaging. | |
| - `template_file` (optional): Path to SAM template file. | |
| - `packaged_template_file` (optional): Path to packaged SAM template file. | |
| - `sam_s3_bucket` (optional): S3 bucket for SAM deployment. | |
| - `sam_s3_prefix` (optional): S3 prefix for SAM deployment. | |
| - `aws_account_region` (optional): AWS region to use for SAM packaging. Only used when `use_aws_sam` is `true`. | |
| - `template_file` (optional): Path to SAM template file. Only used when `use_aws_sam` is `true`. | |
| - `packaged_template_file` (optional): Path to packaged SAM template file. Only used when `use_aws_sam` is `true`. | |
| - `sam_s3_bucket` (optional): S3 bucket for SAM deployment. Only used when `use_aws_sam` is `true`. | |
| - `sam_s3_prefix` (optional): S3 prefix for SAM deployment. Only used when `use_aws_sam` is `true`. |
No description provided.