DR-000018 - Should build (pom.xml) changes required by new RMB be considered breaking?

 

Overrides/Supersedes 

This decision was migrated from the Tech Leads Decision Log as part of a consolidation process.  The original decision record can be found here.

RFC 

N/A

Stakeholders

@Jakub Skoczen @Adam Dickmeiss @Julian Ladisch 

Contributors

@Jakub Skoczen

Approvers

This decision was made by the Tech Leads group prior to the adoption of current decision making processes within the FOLIO project.

Background/Context

The Platform team has been working on restructuring RAML-to-Java generation in RMB to remove the need for dependencies at runtime that should be really be compile-time only. See

RMB-785 - Implementation/Testing/Code Review: Convert GenerateRunner into maven plugin CLOSED for details. From the module implementers viewpoint the following changes will be required in pom.xml:

• See RMB readme: https://github.com/folio-org/raml-module-builder#json-schemas-api

• See RMB readme: https://github.com/folio-org/raml-module-builder#client-generator

• See RMB Upgrading notes: https://github.com/folio-org/raml-module-builder/blob/master/doc/upgrading.md#version-330

 

The Platform team would like your feedback on whether these changes should be considered breaking (RMB v33) or minor (RMB v32.2).

Assumptions

N/A

Constraints

N/A

Rationale

N/A

Decision

Build changes (new RMB Maven plugin) will be released as new major RMB release (v33)

Implications

• Pros

  • N/A

• Cons

  • N/A

Other Related Resources