Skip to content

v5.0.0

Choose a tag to compare

@github-actions github-actions released this 16 Feb 07:46
· 398 commits to main since this release

New major version that removes some old tech debt introduced for backwards API compatibility with minor versions on v4.x and older. This allows extending this plugin with new features moving forwards by removing some limitations around the old way of configuring a couple of aspects.

The changes are fairly minor, but migration details have been added below.

Tip

Users with concerns about making changes across many projects due to being pinned to an older version of this plugin can first upgrade their parent projects to point at v4.1.3 of this plugin while they perform migration steps incrementally.

If there are any concerns or queries, please add a comment to
the discussion.

Protoc plugin declarations

We have removed deprecated legacy protoc plugin parameters from GH-877 -- users must use the plugins parameter instead now.

  • binaryMavenPlugins is removed, use plugins with kind="binary-maven" instead.
  • binaryPathPlugins is removed, use plugins with kind="path" instead.
  • binaryUrlPlugins is removed, use plugins with kind="url" instead.
  • jvmMavenPlugins is removed, use plugins with kind="jvm-maven" instead.

See https://ascopes.github.io/protobuf-maven-plugin/using-protoc-plugins.html for full usage details and examples, but effectively the change that users will want to make is the following:

Old usage:

<configuration>
  <binaryMavenPlugins>
    <binaryMavenPlugin>...</binaryMavenPlugin>
    <binaryMavenPlugin>...</binaryMavenPlugin>
  </binaryMavenPlugins>

  <jvmMavenPlugins>
    <jvmMavenPlugin>...</jvmMavenPlugin>
  </jvmMavenPlugins>
</configuration>

New usage:

<configuration>
  <plugins>
    <plugin kind="binary-maven">...</plugin>
    <plugin kind="binary-maven">...</plugin>
    <plugin kind="jvm-maven">...</plugin>
    <plugin kind="path">...</plugin>
    <plugin kind="url">...</plugin>
    ...
  </plugins>
</configuration>

Old parameter alias removals

Some old parameter aliases have been removed that were in place for backwards compatibility previously:

  • sourcePaths alias for sourceDirectories parameter -- users must ensure they are using sourceDirectories rather than the sourcePaths alias. This was changed to avoid ambiguity with the concept of the system path used within this plugin.
  • Remove protocVersion alias for protoc parameter -- users must change any protocVersion attribute to be protoc. This was changed to allow supporting overriding the full protoc artifact in the future (e.g. to potentially support using WASM builds of protoc that remove the need for platform specific binaries).

See https://ascopes.github.io/protobuf-maven-plugin/generate-mojo.html for the full list of parameters that are supported.

Other changes

  • Dependency updates, including building with a stable release of the Eclipse Sisu Maven Plugin.