Skip to content

chore: update benchmark README #1559

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
merged 1 commit into from
Apr 2, 2025
Merged

chore: update benchmark README #1559

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
5 changes: 1 addition & 4 deletions tests/benchmarks/service-benchmarks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ are complete

## Instructions

To run the benchmarks:
* `./gradlew :tests:benchmarks:service-benchmarks:bootstrapAll`
Copy link
Member

@lauzadis lauzadis Apr 2, 2025

Choose a reason for hiding this comment

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

Also note for other reviewers, bootstrapAll was removed in this PR almost a year ago: #1279

This ensures that all the required service clients are bootstrapped and ready to be built. **You only need to do this
once** in your workspace unless you clean up generated services or make a change to codegen.
Ensure all services, including `iam`, have been generated before proceeding with the benchmarks. To run the benchmarks:
Copy link
Member

@lauzadis lauzadis Apr 2, 2025

Choose a reason for hiding this comment

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

Just wondering, why does iam need a special callout here?

Copy link
Contributor Author

@xinsong-cui xinsong-cui Apr 2, 2025

Choose a reason for hiding this comment

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

Oh, It's because iam is not mention in this README, but it was required to bootstrapall: https://github.com/awslabs/aws-sdk-kotlin/blob/7b786d01beee036540e1bb339f313e7b69029abd/tests/benchmarks/service-benchmarks/build.gradle.kts

I was thinking pointing this out would be less confusing.

* `./gradlew build`
This builds the whole SDK.
* `./gradlew :tests:benchmarks:service-benchmarks:run`
Expand Down
Loading