feat: add detekt Android CI workflow, migrate to ktlint plugin #1122
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
This commit resolves various detekt and ktlint issues in the codebase, including: - Adjusting function and property naming conventions - Addressing long parameter lists and method complexities - Removing magic numbers and unused parameters - Fixing new line and max line length issues - Updating detekt and ktlint configurations in the CI workflow
This commit adds detekt and ktlint to the CI pipeline to ensure code quality and consistency. The new jobs run on Ubuntu and perform the following steps: - Checkout the code - Validate the Gradle wrapper - Mock necessary files for CI - Set up JDK 17 - Setup Gradle - Run detekt or ktlint checks - Upload build reports as artifacts
This commit removes the detekt check from the CI workflow and moves the ktlint check to the pull request workflow. This change streamlines the CI process and ensures that code style is checked before merging.
|
sorry for the churn - first time using github ci |
Renamed build reports artifacts to detekt-reports and ktlint-reports for clarity.
|
can we have all ktlint/detekt files in their respective Meshtastic-Android/config/ktlint/baseline.xml Lines 1 to 2 in 72d7837 Meshtastic-Android/app/config/ktlint/baseline.xml Lines 1 to 2 in 72d7837 Meshtastic-Android/config/detekt/detekt.yml Lines 1 to 2 in 72d7837 Meshtastic-Android/app/detekt-baseline.xml Lines 1 to 2 in 72d7837 |
Configure Detekt and Ktlint with baseline files and move the Detekt configuration to the root level.
|
Put the configs and baselines in the respective root /config folders and updated gradle configs to look for them there. |
|
actually - doing some reading and i may scrap ktlint entirely in favor of just using the ktlint formatting rules plugin available to detekt - moving this back to draft. |
This commit migrates ktlint functionality to the detekt formatting plugin. The ktlint Gradle plugin and related configurations have been removed. Instead, the detekt formatting plugin is now used to enforce code style and formatting. This change simplifies the project's linting setup and consolidates code style enforcement under detekt.
|
Ok, just using the ktlint detekt plugin now. |
jamesarich
changed the title
danwelch3
pushed a commit
to danwelch3/meshtastic-android
that referenced
this pull request
Oct 3, 2024
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 adds the ci workflow job for detekt.
migrates ktlint functionality to detekt plugin
From there, @andrekir, you should be able to add the required check to the branch protection settings, if desired.