Skip to content

chore: Improved --resolve-s3 option documentation and deployment without s3 error messages #2983

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
qingchm merged 5 commits into from
Jul 8, 2021
Merged

chore: Improved --resolve-s3 option documentation and deployment without s3 error messages #2983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
493521c
Improve documentation on --resolve-s3 option and improve s3 failure m…
qingchm Jun 25, 2021
a5890c3
Changed indentation for integration test on s3 error message
qingchm Jun 25, 2021
0b134f3
Fixed a typo in description
qingchm Jun 25, 2021
0707ada
Merge branch 'develop' into develop
qingchm Jul 8, 2021
2811d1d
Improve spacing on help text for resolve-s3 option
qingchm Jul 8, 2021
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
4 changes: 3 additions & 1 deletion samcli/commands/deploy/command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,9 @@
"--resolve-s3",
required=False,
is_flag=True,
help="Automatically resolve s3 bucket for non-guided deployments."
help="Automatically resolve s3 bucket for non-guided deployments. "
"Enabling this option will also create a managed default s3 bucket for you. "
"If you do not provide a --s3-bucket value, the managed bucket will be used. "
"Do not use --s3-guided parameter with this option.",
)
@metadata_override_option
Expand Down
4 changes: 3 additions & 1 deletion samcli/commands/package/command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,9 @@ def resources_and_properties_help_string():
exc_set=PackageResolveS3AndS3SetError,
exc_not_set=PackageResolveS3AndS3NotSetError,
),
help="Automatically resolve s3 bucket for non-guided deployments."
help="Automatically resolve s3 bucket for non-guided deployments. "
"Enabling this option will also create a managed default s3 bucket for you. "
"If you do not provide a --s3-bucket value, the managed bucket will be used. "
"Do not use --s3-guided parameter with this option.",
)
@metadata_override_option
Expand Down
3 changes: 2 additions & 1 deletion samcli/commands/package/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@ class BucketNotSpecifiedError(UserException):
def __init__(self, **kwargs):
self.kwargs = kwargs

message_fmt = "\nS3 Bucket not specified, use --s3-bucket to specify a bucket name or run sam deploy --guided"
message_fmt = "\nS3 Bucket not specified, use --s3-bucket to specify a bucket name, or use --resolve-s3 \
to create a managed default bucket, or run sam deploy --guided"

super().__init__(message=message_fmt.format(**self.kwargs))

Expand Down
3 changes: 2 additions & 1 deletion tests/integration/deploy/test_deploy_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,8 @@ def test_deploy_without_s3_bucket(self, template_file):
self.assertEqual(deploy_process_execute.process.returncode, 1)
self.assertIn(
bytes(
f"S3 Bucket not specified, use --s3-bucket to specify a bucket name or run sam deploy --guided",
f"S3 Bucket not specified, use --s3-bucket to specify a bucket name, or use --resolve-s3 \
to create a managed default bucket, or run sam deploy --guided",
encoding="utf-8",
),
deploy_process_execute.stderr,
Expand Down