Skip to content
This repository has been archived by the owner on Jan 30, 2022. It is now read-only.

2.0.0

Latest
Latest
Compare
Choose a tag to compare
@npepinpe npepinpe released this 12 May 07:42
· 29 commits to master since this release
2.0.0
de6b923

What's Changed

NOTE: this release is a major release, and as such breaks backwards compatibility and may require some manual effort to update.

This release updates the library to be compatible with (and only with) Zeebe 1.0. As Zeebe 1.0's protocol had breaking changes, it was also necessary to introduce similar changes here (such as renaming some record classes). Changes include:

  • Aligning the package structure with Zeebe's protocol package structure: classes are now following the same record.value and record.value.deployment structure as in Zeebe's protocol.
  • Introducing new record types present in Zeebe 1.0
  • Renaming workflow records to process records, as was done in Zeebe 1.0
  • Explicitly exposing the abstract types which were anyway indirectly exposed via the generated code; this will also allow users to extend these types to specify different behaviors if they want to and generate new classes

Updating

This means that you will need to fix the import paths for all Immutable* classes, e.g.:

  • Old: io.zeebe.protocol.immutables.record.ImmutableRecord
  • New: io.zeebe.protocol.immutables.record.value.ImmutableRecord

You will also need to rename all records with Workflow in their name:

  • ImmutableWorkflowInstanceRecordValue -> ImmutableProcessInstanceRecordValue
  • ImmutableWorkflowInstanceSubscriptionRecordValue -> ImmutableProcessMessageSubscriptionRecordValue
  • ImmutableWorkflowInstanceCreationRecordValue -> ImmutableProcessInstanceCreationRecordValue
  • ImmutableWorkflowInstanceResultRecordValue -> ImmutableProcessInstanceResultRecordValue

Note that this is only necessary if you were explicitly using the types.

Contributors

@npepinpe

Assets 3