search

siom79 / japicmp

Comparison of two versions of a jar archive
https://siom79.github.io/japicmp
Apache License 2.0
712 stars 107 forks source link

New option to generate reports in Markdown format `--markdown` #405

Closed guillermocalvo closed 1 month ago

guillermocalvo commented 2 months ago

Solves #404

[!NOTE] An example Markdown report generated for demonstration purposes can be found here.

@siom79 Sorry for the big PR 😅 I tried to make this new functionality as customizable as possible. Please feel free to edit it or suggest any changes you think should be done before it can be merged.

scordio commented 2 months ago

Very cool work @guillermocalvo, thanks for taking this up!

guillermocalvo commented 1 month ago

Excellent work! Thanks very much.

Thanks for your review @siom79! I have implemented your suggestions.

Incidentally, the JDK 8 build failed because the JVM was confused about some Java types 🤔 It's weird, because it was working perfectly fine two weeks ago, so I think the CI worker must be running a different version now. In any case, I extracted an expression to a constant to make sure the compiler understands what the types in play are.

siom79 commented 1 month ago

Thanks @guillermocalvo for implementing the changes. I have resolved the two last remarks myself and merged the result to main.

Btw: Are you interested to become a collaborator on this repository?

guillermocalvo commented 1 month ago

Btw: Are you interested to become a collaborator on this repository?

@siom79 Sounds great! Is there anything specific I can help with?

siom79 commented 1 month ago

@guillermocalvo I have sent you an invitation. Currently there is nothing specific, but as contributor you can merge PRs and do other helpful things. But please be cautious with the new power. :smirk:

guillermocalvo commented 1 month ago

@siom79 Thanks! And don't worry, I know that "with great power comes great responsibility". 😉