Skip to content

add missing doc #7

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.

Sign up for GitHub

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
tmclaugh merged 1 commit into from
Apr 29, 2026
Merged

add missing doc #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ See below for inputs, outputs, and examples.
- `artifact_retention_days` (optional): Number of days to retain artifacts..
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- `artifact_retention_days` (optional): Number of days to retain artifacts..
- `artifact_retention_days` (optional): Number of days to retain artifacts.

Copilot uses AI. Check for mistakes.
- `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.
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
- `sam_s3_bucket` (optional): S3 bucket for SAM deployment.
- `sam_s3_prefix` (optional): S3 prefix for SAM deployment.
Comment on lines 22 to 26
Copy link

Copilot AI Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- `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`.

Copilot uses AI. Check for mistakes.

Expand Down
Loading