Add detekt check in CI #149
Merged
+89
−2
Conversation
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
- Run detekt on PR actions like opened, reopened, synchronised - baseline for detekt has been setup
There was a problem hiding this comment.
Pull Request Overview
This PR integrates Detekt static code analysis into the project to improve code quality and enforce coding standards. The implementation includes comprehensive configuration for the core module, a baseline to track existing issues, and CI integration.
Key Changes
- Added Detekt plugin (version 1.23.8) to the project with configuration for the core module
- Created extensive detekt.yml configuration file with customized rule sets across multiple categories (complexity, style, naming, performance, etc.)
- Integrated Detekt into the CI/CD pipeline to run on pull requests
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| gradle/libs.versions.toml | Added Detekt version 1.23.8 and plugin declaration |
| detekt.yml | Comprehensive Detekt configuration with customized rules for code quality checks |
| core/detekt-baseline.xml | Baseline file tracking 249 pre-existing issues to be addressed incrementally |
| core/build.gradle.kts | Configured Detekt for the core module with source directories, baseline, and reporting options |
| build.gradle.kts | Applied Detekt plugin at the root level |
| .github/workflows/pr_tests.yml | Added Detekt execution step in PR workflow with summary reporting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
alexstyl
requested changes
Nov 6, 2025
Member
alexstyl
left a comment
alexstyl
left a comment
There was a problem hiding this comment.
Thanks for the contribution. Got a few questions and a few change requests
- Simplified the `detekt.yml` configuration by removing many commented-out and default rules, focusing on a stricter, more relevant ruleset. - Increased `maxIssues` to 10. - Disabled several complexity and naming rules (e.g., `LongMethod`, `LongParameterList`, `FunctionNaming`) that are less applicable to Jetpack Compose code. - Updated the Detekt baseline to reflect the new configuration. - Streamlined the Detekt step in the `pr_tests.yml` GitHub workflow.
alexstyl
requested changes
Nov 6, 2025
Member
|
Asked for a file to be renamed as the context changed, plus added some comments in the existing discussions. @raghavsatyadev let me resolve conversations to make sure there is no follow up |
Renamed the `pr_tests.yml` workflow file to `ci.yml` for clarity. Also, corrected the Detekt summary output to properly format it as a markdown code block in the workflow log.
Moves the `Run unit tests` step to execute after the Detekt analysis steps to reject the PR early if it has any code smells.
The Detekt summary is now outputted to the GitHub Step Summary for better visibility in the workflow run.
alexstyl
requested changes
Nov 7, 2025
Member
alexstyl
left a comment
alexstyl
left a comment
There was a problem hiding this comment.
Asked for the last bits of changes.
Removes most of the custom detekt configuration, opting for detekt's defaults. The maximum issue count is increased to 500 to allow the build to pass, and the baseline file has been cleared.
Member
|
Looks good. Let's merge this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Solves #148