Skip to content

Commit 919938f

Browse files
committed
Update README
1 parent 3a01289 commit 919938f

1 file changed

Lines changed: 24 additions & 3 deletions

File tree

v2-migration/README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,29 @@
11
# AWS SDK for Java v2 Migration Tool
22

33
## Description
4-
This modules contains [OpenRewrite][open-rewrite] recipes to automate migration from the AWS SDK for Java v1 to the AWS SDK for Java v2.
4+
This module contains [OpenRewrite][open-rewrite] recipes to automate migration from the AWS SDK for Java v1 to the
5+
AWS SDK for Java v2.
6+
7+
While the majority of v1 code is supported by recipes that transform to the v2 equivalent, there are some classes and
8+
methods not covered by the migration tool. For these classes and methods, refer to our
9+
[Developer Guide][developer-guide-steps] and [API Reference][api-reference-v2] to manually migrate your code.
510

611
## Usage
712

8-
For steps on performing the migration, see our [Developer Guide][developer-guide].
13+
For detailed steps on using the tool, see our [Developer Guide][developer-guide].
14+
15+
### Maven Project
16+
17+
To transform a Maven project, run the following command from your project root directory:
18+
19+
```
20+
mvn org.openrewrite.maven:rewrite-maven-plugin:6.17.0 \
21+
-Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:2.34.0 \
22+
-Drewrite.activeRecipes=software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2
23+
```
24+
25+
**Note:** Newer OpenRewrite versions may not be compatible. If errors occur during the transforms, specify the
26+
[SDK supported version][maven-plugin-version], e.g., `6.17.0`, and run the command again.
927

1028
## Development
1129

@@ -31,4 +49,7 @@ code and ensures it compiles.
3149
[open-rewrite]: https://docs.openrewrite.org/
3250
[rewrite-test]: https://docs.openrewrite.org/authoring-recipes/recipe-testing#rewritetest-interface
3351
[v2-migration-tests]: ../test/v2-migration-tests
34-
[developer-guide]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-tool.html
52+
[developer-guide]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-tool.html
53+
[developer-guide-steps]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-steps.html
54+
[api-reference-v2]: https://sdk.amazonaws.com/java/api/latest/index.html
55+
[maven-plugin-version]: https://github.com/aws/aws-sdk-java-v2/blob/master/test/v2-migration-tests/src/test/java/software/amazon/awssdk/v2migrationtests/MavenTestBase.java#L54

0 commit comments

Comments
 (0)