Introduce API revision checks

Question

Introduce API revision checks

sembler opened this issue 3 years ago · comments

The release of version 1.5.0 revealed some accidental API changes that broke user code. It was suggested that we incorporate Revapi into our build process to compare against previous releases and discover any breaking changes.

Scott Embler · Answer 1 · Thu Jun 17 2021 07:39:20 GMT+0800 (China Standard Time)

@tipsy can we use the verify goal for actions for this project? Or at least include the Revapi 'check' goal?

Scott Embler · Answer 2 · Thu Jun 17 2021 21:50:54 GMT+0800 (China Standard Time)

Looks like the goal change works as expected. I'll merge unless you have concerns @tipsy , @obecker.

Oliver Becker · Answer 3 · Fri Jun 18 2021 02:34:01 GMT+0800 (China Standard Time)

Out of curiosity: what were those incompatible changes? Should we restore something?

Scott Embler · Answer 4 · Fri Jun 18 2021 03:20:38 GMT+0800 (China Standard Time)

26ba4c3

Basically the return types of TagCreator were no longer compatible with compiled libraries. I also noticed that some methods are gone, such as withRole() for ATags. I think we've gone past restoring things at this point. But we can at least ensure that this is more easily caught before merges.

Edit:
You can see the full list of errors by changing <artifact>com.j2html:j2html:1.5.0</artifact> to <artifact>com.j2html:j2html:1.4.0</artifact> in the POM for the revapi-maven-plugin. and then running the verify phase.

Oliver Becker · Answer 5 · Fri Jun 18 2021 14:37:23 GMT+0800 (China Standard Time)

Yes, probably 1.5.0 should have been 2.0.0.
The generated classes support only those attributes that are allowed per HTML specification, so many (wrongly used) attributes are gone, which is indeed no longer compatible.