Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion test/v2-migration-tests/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>v2-migration</artifactId>
<version>${project.version}-PREVIEW</version>
<version>${project.version}</version>
<scope>test</scope>
</dependency>
<dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ static void setUp() throws IOException {

Files.setPosixFilePermissions(gradlew, perms);

replaceVersion(gradleActual.resolve("init.gradle"), getMigrationToolVersion() + "-PREVIEW");
replaceVersion(gradleActual.resolve("init.gradle"), getMigrationToolVersion());
}

private static void deleteTempDirectories() throws IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@ protected static void verifyTransformation() throws IOException {
// pin version since updates have broken tests
String rewriteMavenPluginVersion = "6.17.0";
addAll(rewriteArgs, "mvn", "org.openrewrite.maven:rewrite-maven-plugin:" + rewriteMavenPluginVersion + ":run",
"-Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:"+ getMigrationToolVersion() + "-PREVIEW",
recipeCmd);
"-Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:"+ getMigrationToolVersion(), recipeCmd);

run(mavenActual, rewriteArgs.toArray(new String[0]));
FileUtils.deleteDirectory(mavenActual.resolve("target").toFile());
Expand Down
27 changes: 24 additions & 3 deletions v2-migration/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
# AWS SDK for Java v2 Migration Tool

## Description
This modules contains [OpenRewrite][open-rewrite] recipes to automate migration from the AWS SDK for Java v1 to the AWS SDK for Java v2.
This module contains [OpenRewrite][open-rewrite] recipes to automate migration from the AWS SDK for Java v1 to the
AWS SDK for Java v2.

While the majority of v1 code is supported by recipes that transform to the v2 equivalent, there are some classes and
methods not covered by the migration tool. For these classes and methods, refer to our
[Developer Guide][developer-guide-steps] and [API Reference][api-reference-v2] to manually migrate your code.

## Usage

For steps on performing the migration, see our [Developer Guide][developer-guide].
For detailed steps on using the tool, see our [Developer Guide][developer-guide].

### Maven Project

To transform a Maven project, run the following command from your project root directory:

```
mvn org.openrewrite.maven:rewrite-maven-plugin:6.17.0 \
-Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:2.34.0 \
-Drewrite.activeRecipes=software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2
```

**Note:** Newer OpenRewrite versions may not be compatible. If errors occur during the transforms, specify the
[SDK supported version][maven-plugin-version], e.g., `6.17.0`, and run the command again.

## Development

Expand All @@ -31,4 +49,7 @@ code and ensures it compiles.
[open-rewrite]: https://docs.openrewrite.org/
[rewrite-test]: https://docs.openrewrite.org/authoring-recipes/recipe-testing#rewritetest-interface
[v2-migration-tests]: ../test/v2-migration-tests
[developer-guide]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-tool.html
[developer-guide]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-tool.html
[developer-guide-steps]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-steps.html
[api-reference-v2]: https://sdk.amazonaws.com/java/api/latest/index.html
[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
2 changes: 1 addition & 1 deletion v2-migration/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
</parent>

<artifactId>v2-migration</artifactId>
<version>${awsjavasdk.version}-PREVIEW</version>
<version>${awsjavasdk.version}</version>
<name>AWS Java SDK :: V2 Migration</name>
<description>
Contains OpenRewrite recipes to help users migrate from the AWS SDK for Java v1 to the AWS SDK for Java v2
Expand Down