Skip to content

Commit 52911f8

Browse files
authored
Migration Tool: Add services to Enum recipe and update ReadMe (#5499)
* Add services to enum recipe and update ReadMe * Update ReadMe
1 parent 4894f88 commit 52911f8

File tree

3 files changed

+645
-32
lines changed

3 files changed

+645
-32
lines changed

v2-migration/README.md

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,7 @@ This modules contains [OpenRewrite][open-rewrite] recipes to automate migration
55

66
## Usage
77

8-
You can use [OpenRewrite Maven plugin][open-rewrite-plugin] to start the migration. See [Running OpenRewrite Recipes][open-rewrite-usage] for more information.
9-
To get started, you can either perform a dry run or run directly.
10-
11-
- Dry Run
12-
13-
With this mode, it generates diff logs in the console as well as diff file in the `target` folder.
14-
Note that you need to replace `{sdkversion}` with the actual SDK version. See [Maven Central][maven-central] to
15-
find the latest version.
16-
17-
```
18-
mvn org.openrewrite.maven:rewrite-maven-plugin:dryRun \
19-
-Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:{sdkversion} \
20-
-Drewrite.activeRecipes=software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2
21-
```
22-
23-
- Run
24-
25-
With this mode, it runs the SDK recipes and applies the changes locally.
26-
27-
```
28-
mvn org.openrewrite.maven:rewrite-maven-plugin:run \
29-
-Drewrite.recipeArtifactCoordinates=software.amazon.awssdk:v2-migration:{sdkversion} \
30-
-Drewrite.activeRecipes=software.amazon.awssdk.v2migration.AwsSdkJavaV1ToV2
31-
```
32-
8+
For steps on performing the migration, see our [Developer Guide][developer-guide].
339

3410
## Development
3511

@@ -53,8 +29,6 @@ sample applications using the AWS SDK for Java v1 and compares the transformed c
5329
code and ensures it compiles.
5430

5531
[open-rewrite]: https://docs.openrewrite.org/
56-
[open-rewrite-usage]: https://docs.openrewrite.org/running-recipes
57-
[open-rewrite-plugin]: https://docs.openrewrite.org/reference/rewrite-maven-plugin
58-
[maven-central]: https://central.sonatype.com/artifact/software.amazon.awssdk/v2-migration
59-
[rewrite-test]:https://docs.openrewrite.org/authoring-recipes/recipe-testing#rewritetest-interface
60-
[v2-migration-tests]:../test/v2-migration-tests
32+
[rewrite-test]: https://docs.openrewrite.org/authoring-recipes/recipe-testing#rewritetest-interface
33+
[v2-migration-tests]: ../test/v2-migration-tests
34+
[developer-guide]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-tool.html

0 commit comments

Comments
 (0)