diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 534759b..2aced3a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -95,14 +95,12 @@ jobs: ## [Changelog](https://github.com/xdev-software/${{ env.PRIMARY_MAVEN_MODULE }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }}) See [Changelog#v${{ steps.version.outputs.release }}](https://github.com/xdev-software/${{ env.PRIMARY_MAVEN_MODULE }}/blob/develop/CHANGELOG.md#${{ steps.version.outputs.releasenumber }}) for more information. - ## Installation - Add the following lines to your pom: - ```XML - - software.xdev - ${{ env.PRIMARY_MAVEN_MODULE }} - ${{ steps.version.outputs.release }} - + ## Usage + Execute the following maven command in the maven project that you want to migrate: + ``` + mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \ + -Drewrite.recipeArtifactCoordinates=software.xdev:${{ env.PRIMARY_MAVEN_MODULE }}:${{ steps.version.outputs.release }} \ + -Drewrite.activeRecipes=software.xdev.spring.data.eclipse.store.JpaMigration ``` publish_central: # Publish the code to central diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29..72ba701 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# 1.0.0 + +* Initial release diff --git a/README.md b/README.md index e0084bb..0589270 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,22 @@ # spring-data-eclipse-store-migration +Migrates your Spring-Data-JPA-project +to [Spring-Data-Eclipse-Store](https://github.com/xdev-software/spring-data-eclipse-store) +through a [OpenRewrite](https://docs.openrewrite.org/)-Recipe. + ## Usage -``` -mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \ - -Drewrite.recipeArtifactCoordinates=software.xdev:spring-data-eclipse-store-migration:1.0.0-SNAPSHOT \ - -Drewrite.activeRecipes=software.xdev.spring.data.eclipse.store.JpaMigration -``` +[Usage guide for the latest release](https://github.com/xdev-software/spring-data-eclipse-store-migration/releases/latest#Usage > [!CAUTION] > Since Spring-Data-Eclipse-Store can't handle ```@Query```-Annotations, > these annotations are getting removed by the Rewrite-Recipe. ## Support -If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support). + +If you need support as soon as possible, and you can't wait for any pull request, feel free to +use [our support](https://xdev.software/en/services/support). ## Contributing See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.