Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: revert add copyright header checks using maven checkstyle plugin #5665

Merged
merged 1 commit into from
Jan 23, 2025

Conversation

mattdibi
Copy link
Contributor

@mattdibi mattdibi commented Jan 23, 2025

This PR reverts the checkstyle check introduced in #5649.

The solution implemented in #5649 falls short in the following areas:

  • Coverage: it only handles .java files. I thought I could be able to add additional header checks but that wasn't the case. Additionally our checkstyle checks are skipped in a lot of packages. I initially thought that the only packages for which the exclusion was active were in the suppression.xml file. This wasn't the case. I started working on it in ci: extend checkstyle plugin coverage #5656 but the task grew too big and the need for a different approach is required.
  • Scale: this approach doesn't scale very well to our other projects. It requires the checkstyle maven plugin which is not commonly used in our project as I initially thought.
  • Usage: as @salvatore-coppola pointed out in build: add copyright header checks using maven checkstyle plugin #5649 (comment), the check fails when the build is launched from another directory.

Due to the above we're now reverting the change.

@MMaiero MMaiero merged commit a12c088 into develop Jan 23, 2025
5 checks passed
@MMaiero MMaiero deleted the revert/copyright_header_2 branch January 23, 2025 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants