Skip to content

Commit 45c4255

Browse files
committed
Add instructions for how to run CI tests locally
1 parent abd1814 commit 45c4255

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

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, 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

0 commit comments

Comments
 (0)