Merged
Conversation
poikilotherm
added
Type: Feature
poikilotherm
force-pushed
the
6070-reviewdog-checkstyle
branch
from
ab1a391 to
749a33e
Compare
pdurbin
approved these changes
May 28, 2021
Member
There was a problem hiding this comment.
This seems great. It's using our existing checkstyle.xml config that we document at https://guides.dataverse.org/en/5.5/developers/coding-style.html#checking-your-formatting-with-checkstyle
I doubt developers are actively running mvn checkstyle:checkstyle before running a pull request. (I'm not.) This automates that process.
After we get comfortable with it we might want to add some extra docs somewhere to explain to people making pull requests that a dog might bark at them but that it's ok and that we're still friendly to contributors. 😄 🐶
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
What this PR does / why we need it:
Now that #7801 has been merged and #6070 is resolved, we should make sure that no one reintroduces using the Apache Commons Lang v2 library by misusing a transitive dependency.
This PR will create a Github Action using @reviewdog to bark on any NEW
checkstyleviolations (not the existing), which includes making imports from the Java package invalid.Which issue(s) this PR closes:
Relates to #6070
Special notes for your reviewer:
See #7886 for a demo (although it does not yet use inline review comments as used from a fork).
Suggestions on how to test this:
See the demo ;-)
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Nope.
Is there a release notes update needed for this change?:
Nope.
Additional documentation:
We can enable more rules in the future. It would be good to check for code styling on new PRs and not rely on humans for that chore task.