Initial configuration of revapi to detect API incompatibility.

[cescoffier]

Configure revapi.

Didn't work on the release tooling yet, but should not be hard.

[cescoffier]

@radcortez @kenfinnigan FYI - it can be useful for SmallRye in general

[jponge]

I'll have a look later.

Meanwhile @cescoffier would you put your jbang script somewhere?

[codecov]

Codecov Report

Merging #356 (faab232) into master (28579bf) will increase coverage by 0.08%.
The diff coverage is 100.00%.

@@             Coverage Diff              @@
##             master     #356      +/-   ##
============================================
+ Coverage     89.29%   89.37%   +0.08%     
- Complexity     2715     2720       +5     
============================================
  Files           361      361              
  Lines         10478    10489      +11     
  Branches       1302     1304       +2     
============================================
+ Hits           9356     9375      +19     
+ Misses          583      577       -6     
+ Partials        539      537       -2     

Impacted Files	Coverage Δ	Complexity Δ
...java/io/smallrye/mutiny/helpers/Subscriptions.java	79.55% <100.00%> (ø)	48.00 <0.00> (ø)
...mallrye/mutiny/operators/multi/MultiGroupByOp.java	82.81% <100.00%> (ø)	2.00 <0.00> (ø)
.../io/smallrye/mutiny/helpers/queues/DrainUtils.java	77.77% <0.00%> (-2.23%)	12.00% <0.00%> (ø%)
...tiny/operators/multi/MultiBufferWithTimeoutOp.java	70.33% <0.00%> (-1.70%)	3.00% <0.00%> (ø%)
...mallrye/mutiny/operators/multi/MultiFlatMapOp.java	86.64% <0.00%> (-0.32%)	3.00% <0.00%> (ø%)
...a/io/smallrye/mutiny/converters/multi/ToMaybe.java	100.00% <0.00%> (ø)	4.00% <0.00%> (ø%)
...rye/mutiny/operators/multi/MultiRepeatUntilOp.java	100.00% <0.00%> (ø)	5.00% <0.00%> (ø%)
...perators/multi/processors/SerializedProcessor.java	93.06% <0.00%> (ø)	26.00% <0.00%> (ø%)
...e/mutiny/streams/stages/FindFirstStageFactory.java	100.00% <0.00%> (ø)	5.00% <0.00%> (ø%)
... and 12 more

[kenfinnigan]

Awesome, does this produce a report in the build output? Does it feed into a release note, maybe?

[jponge]

Definitely a great addition as long as maintenance does not become a nightmare ;-)

[cescoffier]

@kenfinnigan At the moment, it only generates reports as JSON and also fails the build if there is a non-justified breaking change.

From that, I will write a script that collects all the JSON files and build the list to add to the release notes (we already generate the release notes during the release process). At the same time, I will update the json file to "clear" the list of differences.

So, when we introduce a breaking change:

• the build will fail
• we update the difference list and give a justification
• the build will then pass
• during the release, the list of differences is extracted and appended to the release note with the justification (which could be a work around, for example, for long deprecated methods).
• during the release the list of differences is cleared

BTW, to add a difference, you need to edit a json file, but the content is provided in the build log (Expect the justification, of course)

[cescoffier]

@kenfinnigan @jponge I just pushed the JBang script (located in .build):

It extracts the breaking changes and generates a markdown file which can be appended to the release notes (not done yet)

$ .build/CompatibilityUtils.java extract                                                                                                                 
🔎 Found revapi.json file: /Users/clement/Projects/microprofile/mutiny/implementation/revapi.json
🔎 Found revapi.json file: /Users/clement/Projects/microprofile/mutiny/rxjava/revapi.json
🔎 Found revapi.json file: /Users/clement/Projects/microprofile/mutiny/reactor/revapi.json
🧮 1 difference(s) found
💽 File /Users/clement/Projects/microprofile/mutiny/target/differences.md written

It can also clear the differences (after a release for example). It only touches files containing differences with justifications:

$  jbang .build/CompatibilityUtils.java clear  
🔎 Clearing differences from revapi.json file: /Users/clement/Projects/microprofile/mutiny/implementation/revapi.json
📁 Updating /Users/clement/Projects/microprofile/mutiny/implementation/revapi.json
🔎 Clearing differences from revapi.json file: /Users/clement/Projects/microprofile/mutiny/rxjava/revapi.json
🔎 Clearing differences from revapi.json file: /Users/clement/Projects/microprofile/mutiny/reactor/revapi.json

Next step is to run these commands during the release.

[cescoffier]

Release script updated! All done!

[jponge]

This is great this way!

[cescoffier]

That's because of the emojis aka Philippe's touch ;-)

[jponge]

That's because of the emojis aka Philippe's touch ;-)

Emojis are life /cc @k33g