migration-to-5.0.0.md

Some breaking changes were introduced in Release 5.0.0. So if you were using version 4.x.x then please follow steps below. Note: if you are migrating from version 3.x.x or earlier, then please also follow 4.0.0 migration guide first.

NOTE

Migration from 4.x.x to 5.0.0 is required only if you were using external mapping configuration. Otherwise - feel free to use graphql-java-codegen-5.0.0 without any breaking changes.

Migration steps

1. Update plugin and library versions

As per plugin description: Gradle, Maven, SBT

2. Rename jsonConfigurationFile => configurationFiles

Maven

<configuration>
    <!--OLD APPROACH-->
    <jsonConfigurationFile>src/main/resources/mappingConfig.json</jsonConfigurationFile>
    <!--OLD APPROACH-->

    <!--NEW APPROACH-->
    <configurationFiles>
      <configurationFile>src/main/resources/mappingConfig.json</configurationFile>
    </configurationFiles>
    <!--NEW APPROACH-->
</configuration>

Gradle

// OLD APPROACH
jsonConfigurationFile="src/main/resources/mappingConfig.json"
// OLD APPROACH

// NEW APPROACH
configurationFiles=["src/main/resources/mappingConfig.json"]
// NEW APPROACH

SBT

// OLD APPROACH
jsonConfigurationFile := Some("src/main/resources/mappingConfig.json")
// OLD APPROACH

// NEW APPROACH
configurationFiles := List("src/main/resources/mappingConfig.json")
// NEW APPROACH

3. Regenerate the code

Run project build so that GraphQL classes are regenerated and your code compiles.

---

Feel free to ask any questions in GitHub Discussions or create an issue if you discover some problems.