Skip to content

Commit 6ada5ed

Browse files
authored
Merge branch 'master' into dongie/endpoint-not-acquired-fix
2 parents baa1642 + 1262ba6 commit 6ada5ed

4 files changed

Lines changed: 74 additions & 1 deletion

File tree

.all-contributorsrc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1138,6 +1138,15 @@
11381138
"contributions": [
11391139
"maintenance"
11401140
]
1141+
},
1142+
{
1143+
"login": "humanzz",
1144+
"name": "Ahmed Kamel",
1145+
"avatar_url": "https://avatars.githubusercontent.com/u/5001?v=4",
1146+
"profile": "https://github.com/humanzz",
1147+
"contributions": [
1148+
"code"
1149+
]
11411150
}
11421151
],
11431152
"contributorsPerLine": 7,

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ __Jump To:__
88
* [Bug Reports](#bug-reports)
99
* [Feature Requests](#feature-requests)
1010
* [Code Contributions](#code-contributions)
11+
* [Running CI Checks Locally](#running-ci-checks-locally)
1112
* [Additional Resources](#additional-resources)
1213

1314
## Bug Reports
@@ -146,6 +147,45 @@ days, especially if it's a large or complex one. If, after a week, your Pull
146147
Request has not had any engagement from the SDK team, feel free to ping a
147148
member to ask for a review.
148149

150+
### Running CI Checks Locally
151+
152+
CI runs unit tests, integration tests, Checkstyle, and SpotBugs on every PR.
153+
While not required before opening a PR, running these locally helps catch issues early and speeds up the code review cycle.
154+
155+
#### Unit Tests (Full Build)
156+
157+
```sh
158+
mvn clean install
159+
```
160+
161+
To iterate faster, build only the modules you're working on:
162+
163+
```sh
164+
mvn clean install -pl :dynamodb-enhanced -am
165+
```
166+
167+
#### Integration Tests
168+
169+
Integration tests make real AWS API calls and will incur costs to the account owner.
170+
They require an `aws-test-account` profile in `~/.aws/credentials`:
171+
172+
```
173+
[aws-test-account]
174+
aws_access_key_id = <your-access-key>
175+
aws_secret_access_key = <your-secret-key>
176+
```
177+
178+
If this profile is not found, the tests fall back to the default credential provider chain.
179+
180+
```sh
181+
# All integration tests
182+
mvn clean install -Dskip.unit.tests -P integration-tests -Dfindbugs.skip -Dcheckstyle.skip
183+
184+
# Specific module
185+
mvn clean install -pl :dynamodb-enhanced -am -Dskip.unit.tests -P integration-tests -Dfindbugs.skip -Dcheckstyle.skip
186+
```
187+
188+
149189
## Additional Resources
150190
We maintain [docs](docs/README.md) where information like design decisions, internal
151191
architecture, and style conventions are documented that you may find helpful

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Maven](https://img.shields.io/maven-central/v/software.amazon.awssdk/s3.svg?label=Maven)](https://search.maven.org/search?q=g:%22software.amazon.awssdk%22%20AND%20a:%22s3%22)
44
[![codecov](https://codecov.io/gh/aws/aws-sdk-java-v2/branch/master/graph/badge.svg)](https://codecov.io/gh/aws/aws-sdk-java-v2)
55
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
6-
[![All Contributors](https://img.shields.io/badge/all_contributors-125-orange.svg?style=flat-square)](#contributors-)
6+
[![All Contributors](https://img.shields.io/badge/all_contributors-127-orange.svg?style=flat-square)](#contributors-)
77
<!-- ALL-CONTRIBUTORS-BADGE:END -->
88

99
The **AWS SDK for Java 2.0** is a rewrite of 1.0 with some great new features. As with version 1.0,
@@ -352,6 +352,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
352352
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ryanyuan"><img src="https://avatars.githubusercontent.com/u/7124535?v=4?s=100" width="100px;" alt="Ryan Yuan"/><br /><sub><b>Ryan Yuan</b></sub></a><br /><a href="https://github.com/aws/aws-sdk-java-v2/commits?author=ryanyuan" title="Documentation">📖</a></td>
353353
<td align="center" valign="top" width="14.28%"><a href="https://github.com/salmanmkc"><img src="https://avatars.githubusercontent.com/u/32169182?v=4?s=100" width="100px;" alt="Salman Chishti"/><br /><sub><b>Salman Chishti</b></sub></a><br /><a href="#maintenance-salmanmkc" title="Maintenance">🚧</a></td>
354354
</tr>
355+
<tr>
356+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/humanzz"><img src="https://avatars.githubusercontent.com/u/5001?v=4?s=100" width="100px;" alt="Ahmed Kamel"/><br /><sub><b>Ahmed Kamel</b></sub></a><br /><a href="https://github.com/aws/aws-sdk-java-v2/commits?author=humanzz" title="Code">💻</a></td>
357+
</tr>
355358
</tbody>
356359
</table>
357360

docs/user-agent.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# User Agent
2+
3+
## Additional Metadata
4+
5+
The table below documents additional metadata the SDK may include in the `User-Agent` header of a request. These take the form of `md/[name]#[value]` in the request.
6+
7+
|Name|Value(s)|Description|
8+
|---|---|---|
9+
|`rb`||The request body implementation. This includes `ContentStreamProvider` for sync clients, and `AsyncRequestBody` for async clients.|
10+
||`f`|"File". The body implementation reads from a file.|
11+
||`b`|"Bytes". The body implementation reads from a byte array.|
12+
||`c`|"String" The body implementation reads from a string. |
13+
||`s`|"Stream". The body implementation reads from an `InputStream`.|
14+
||`p`|"Publisher". The body implementation reads from an `SdkPublisher`.|
15+
||`u`|"unknown"|
16+
|`rt`||The response transformer implementation. This includes `ResponseTransformer` for sync clients, and `AsyncResponseTransformer` for async clients.|
17+
||`f`|"File". The response transformer writes the response body to a file.|
18+
||`b`|"Bytes". The response transformer writes the response body to a byte array.|
19+
||`s`|"Stream". The response transformer adapts the response body to an `InputStream`.|
20+
||`p`|"Publisher". The response transformer adapts the response body to an `SdkPublisher`.|
21+
||`u`|"unknown"|

0 commit comments

Comments
 (0)