Rename proguard task to generateFeaturedProguardRules#190
Conversation
Review Summary by QodoRename proguard task to generateFeaturedProguardRules
WalkthroughsDescription• Rename Gradle task generateProguardRules to generateFeaturedProguardRules • Namespace task with featured prefix to avoid plugin clashes • Update all test cases and documentation references • Keep Kotlin class and constant identifier unchanged Diagramflowchart LR
A["Task Name Change"] -->|"generateProguardRules"| B["generateFeaturedProguardRules"]
B -->|"Update References"| C["Tests"]
B -->|"Update References"| D["Documentation"]
B -->|"Update References"| E["README & Guides"]
File Changes1. featured-gradle-plugin/src/main/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPlugin.kt
|
Code Review by Qodo
1.
|
There was a problem hiding this comment.
Pull request overview
This PR renames the Featured Gradle plugin’s ProGuard/R8 generation task from generateProguardRules to generateFeaturedProguardRules to avoid task-name clashes while keeping the underlying task class and constant identifier unchanged.
Changes:
- Updates the registered Gradle task name string.
- Updates tests to invoke/assert the new task name.
- Updates user-facing documentation and plugin notes to reference the renamed task.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
featured-gradle-plugin/src/main/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPlugin.kt |
Renames the registered ProGuard task name. |
featured-gradle-plugin/src/test/kotlin/dev/androidbroadcast/featured/gradle/GenerateProguardRulesTaskRegistrationTest.kt |
Updates task registration test names for the renamed task. |
featured-gradle-plugin/src/test/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPluginIntegrationTest.kt |
Updates integration tests to run and assert the renamed task. |
README.md |
Updates public usage examples and task list references. |
featured-gradle-plugin/CLAUDE.md |
Updates plugin task documentation. |
docs/api/index.md |
Updates API task reference. |
docs/guides/android.md |
Updates Android guide manual task invocation. |
docs/guides/best-practices.md |
Updates best-practices cleanup command. |
Add `### Changed` entry under `## Unreleased` documenting the task rename with a one-line migration note. Append `scanAllLocalFlags` to the parenthesized task list in the Configuration Cache section of README so it matches the set of tasks actually registered by the plugin. Refs PR #190 review comments from qodo-code-review and copilot-pull-request-reviewer.
Namespace the Gradle task with the `featured` prefix to avoid clashes with other plugins that register a similarly named task. The Kotlin class GenerateProguardRulesTask and the GENERATE_PROGUARD_TASK_NAME constant identifier stay the same — only the task name string and its references in tests and docs change.
Add `### Changed` entry under `## Unreleased` documenting the task rename with a one-line migration note. Append `scanAllLocalFlags` to the parenthesized task list in the Configuration Cache section of README so it matches the set of tasks actually registered by the plugin. Refs PR #190 review comments from qodo-code-review and copilot-pull-request-reviewer.
e11eeb5 to
e7a3c66
Compare
Summary
generateProguardRules→generateFeaturedProguardRules(namespace the task with thefeaturedprefix to avoid clashes with other plugins that register a similarly named task).featured-gradle-plugin/CLAUDE.md,README.md,docs/api/index.md,docs/guides/{android,best-practices}.md.GenerateProguardRulesTaskand constant identifierGENERATE_PROGUARD_TASK_NAMEintentionally unchanged — only the task name string changes (minimal diff).docs/specs/anddocs/cc-verification/left as-is (audit snapshots).Test plan
./gradlew spotlessApply— BUILD SUCCESSFUL./gradlew :featured-gradle-plugin:test— BUILD SUCCESSFUL