Add revapi as option during build #11277
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boring-cyborg
bot
added
the
area/dependencies
Open
|
I don't think I can meaningfully review this before I get back from PTO. But as soon as I do, it will be one of the first things I do |
|
I just saw that this just configures revapi and doesn't enable it in any way. I would still prefer if someone else pulled the trigger on it as I won't really be around for follow-ups and subsequent discussions. |
understood - there isn't much to it though; should have zero effect on build both locally and in CI but lets us try out revapi configs in tiny PR updates. |
gsmet
requested changes
Aug 10, 2020
maxandersen
force-pushed
the
justrevapi
branch
from
dc650d3 to
62380f0
Compare
Initial setup of revapi to get API change reports. Still ways to go in tuning it; but would like to have it included in master now to make coming PR's simpler to apply/manage. This adds a profile to run api check - it is not currently activated by default but should be in the future when we have the defaults tuned in to not generate unwarranted noise. Also `revapi.skip` is default true, meaning even when the profile is active no api check will be done on a module unless it defines `revapi.skip=true` in its properties. Thus for now to even have it run you need enable the api-check profile *and* the property. i.e. `mvn -Papi-check -Drevapi.skip=false` If you want to run it for everything (ignoring revapi.skip do the following:: `mvn -Papi-check -Drevapi.skip=false -DskipTests verify` If you want to see it detect changes in dependencies that quarkus exposes/uses add `-Drevapi.checkdeps=true` When run you should get a `target/revapi-results/` in every module that are included in the check. That folder will have a `.json` and `.adoc` file capturing detected API changes/issues. If you want to tweak the format of the `.adoc` file you can change that in revapi/**/*.ftl and do a `mvn install` to have changes picked up.
|
I made some changes to disable the profile by default: it now needs to be enabled explicitly. |
gsmet
approved these changes
Aug 13, 2020
gsmet
added
the
triage/waiting-for-ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is related to #10453 but just includes the minimal setup to run revapi (no modules gets it enabled; that will be future PR's)
Initial setup of revapi to get API change reports.
Still ways to go in tuning it; but would like to have it included in master
now to make coming PR's simpler to apply/manage.
This adds a profile to run api check - it is not currently activated by default
but should be in the future when we have the defaults tuned in to not generate
unwarranted noise.
Also
revapi.skipis default true, meaning even when the profile is active no api checkwill be done on a module unless it defines
revapi.skip=truein its properties.Thus for now to even have it run you need enable the api-check profile and the property.
i.e.
mvn -Papi-check -Drevapi.skip=falseIf you want to run it for everything (ignoring revapi.skip do the following::
mvn -Papi-check -Drevapi.skip=false -DskipTests verifyIf you want to see it detect changes in dependencies that quarkus exposes/uses add
-Drevapi.checkdeps=trueWhen run you should get a
target/revapi-results/in every module that are included in the check.That folder will have a
.jsonand.adocfile capturing detected API changes/issues.If you want to tweak the format of the
.adocfile you can change that in revapi/**/*.ftland do a
mvn installto have changes picked up.