Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
MicroProfile/BreakingChanges
< MicroProfile
Revision as of 12:15, 1 May 2019 by Emijiang6.googlemail.com (Talk | contribs) (Document the process how to communicate breaking changes)
This page lists what do you when a break change is introduced in a MP Spec.
What is a breaking change
Breaking changes mean backward incompatible changes, e.g. an API method was deleted or modified, etc. With a breaking change, microservices developed using old version of an API will cease to compile or result into behaviour change.
How can I handle the breaking change
If a breaking change is introduced in a MP spec, a subsection under release note must need to document what the breaking changes are. Ideally, if applicable, a solution needs to be provided for going back to the old behaviour.
For an instance, MicroProfile Metrics 2.0 changes @Counted(monotonic=true) to be @Counted, while the previous old behaviour of @Counted can be achieved via '@ConcurrentGauge`