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

Reactivate Checkstyle #3539

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

wadoon
Copy link
Member

@wadoon wadoon commented Jan 22, 2025

Someone deactivated Sonarqube. We seem to have a deeper inner confusion with our common understanding of clean code.

First, this PR reactivates the Checkstyle on changed files still within Gradle.

  1. Checkstyle is executed on all changed files in comparison to origin/main. This solution does not respect lines.
  2. Reporting works overall possible reliable ways:
    1. Markdown Job summary is added
      image
    2. A Sarif file is uploaded to the repository:
      image
    3. Artifact can be downloaded:
      image
    4. It does not add a comment to the PR as this is not reliable due to reduced permissions on workflow executions for foreign repositories.

Second, it also brings some updates w.r.t. deprecation warnings and hints in/for Gradle.

  1. task.register is prior to just task <name> due to laziness in initialization
  2. Variable $buildDir is deprecated and we should use layout.buildDirectory
  3. Jacoco is now integrated in the regular Gradle files (no conditional loading anymore), and the enabled switch is used for activation/deactiviation.
  4. At the end of the Github tests runs, a Python scripts runs through the JUnit test summaries and prints out Github annotations.
  5. Increment Gradle version

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@wadoon wadoon requested a review from mattulbrich January 22, 2025 15:47
@wadoon wadoon self-assigned this Jan 22, 2025
@wadoon wadoon added 🛠 Maintenance Code quality and related things w/o functional changes github_actions Pull requests that update GitHub Actions code labels Jan 22, 2025
@wadoon wadoon added this to the v2.12.4 milestone Jan 22, 2025
@wadoon wadoon changed the title testing checkstyle Reactivate Checkstyle Jan 22, 2025
@wadoon
Copy link
Member Author

wadoon commented Jan 22, 2025

Missing check, if no Java files were altered.

@KeYProject KeYProject deleted a comment from codecov bot Jan 29, 2025
Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 38.39%. Comparing base (181fb2a) to head (1947eb5).
Report is 36 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #3539   +/-   ##
=========================================
  Coverage     38.39%   38.39%           
  Complexity    17238    17238           
=========================================
  Files          2099     2099           
  Lines        127342   127342           
  Branches      21446    21446           
=========================================
  Hits          48890    48890           
  Misses        72440    72440           
  Partials       6012     6012           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mattulbrich
Copy link
Member

Someone deactivated Sonarqube. We seem to have a deeper inner confusion with our common understanding of clean code.

If there is confusion, should that not be cleared first? What is the confusion about?

@wadoon
Copy link
Member Author

wadoon commented Feb 20, 2025

If there is confusion, should that not be cleared first? What is the confusion about?

This was just an euphemism for we agreed on Sonarcube, set up the rules, and someone deactivates it. This leads to questions.

Copy link
Member

@mattulbrich mattulbrich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The newly introduced check still fails.

Regarding tools like SonarCube:
CodeQuality measuring gates help improve the code. However, they must work properly. If they fail consistently and are not repaired, they should be turned off.

@mattulbrich mattulbrich added the Reviewer Feedback Feedback from the review needs to be addressed label Feb 22, 2025
@wadoon wadoon force-pushed the weigl/checkstyle branch 2 times, most recently from 1947eb5 to a827455 Compare March 12, 2025 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github_actions Pull requests that update GitHub Actions code 🛠 Maintenance Code quality and related things w/o functional changes Reviewer Feedback Feedback from the review needs to be addressed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants