Skip to content

Rename proguard task to generateFeaturedProguardRules#190

Merged
kirich1409 merged 2 commits into
developfrom
chore/rename-proguard-task
May 18, 2026
Merged

Rename proguard task to generateFeaturedProguardRules#190
kirich1409 merged 2 commits into
developfrom
chore/rename-proguard-task

Conversation

@kirich1409
Copy link
Copy Markdown
Contributor

Summary

  • Renames the Gradle task generateProguardRulesgenerateFeaturedProguardRules (namespace the task with the featured prefix to avoid clashes with other plugins that register a similarly named task).
  • Updates references in tests, featured-gradle-plugin/CLAUDE.md, README.md, docs/api/index.md, docs/guides/{android,best-practices}.md.
  • Kotlin class GenerateProguardRulesTask and constant identifier GENERATE_PROGUARD_TASK_NAME intentionally unchanged — only the task name string changes (minimal diff).
  • Dated historical docs under docs/specs/ and docs/cc-verification/ left as-is (audit snapshots).

Test plan

  • ./gradlew spotlessApply — BUILD SUCCESSFUL
  • ./gradlew :featured-gradle-plugin:test — BUILD SUCCESSFUL
  • CI green on the PR

Copilot AI review requested due to automatic review settings May 17, 2026 16:38
@qodo-code-review
Copy link
Copy Markdown

Review Summary by Qodo

Rename proguard task to generateFeaturedProguardRules

✨ Enhancement

Grey Divider

Walkthroughs

Description
• 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
Diagram
flowchart LR
  A["Task Name Change"] -->|"generateProguardRules"| B["generateFeaturedProguardRules"]
  B -->|"Update References"| C["Tests"]
  B -->|"Update References"| D["Documentation"]
  B -->|"Update References"| E["README & Guides"]
Loading

Grey Divider

File Changes

1. featured-gradle-plugin/src/main/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPlugin.kt ✨ Enhancement +1/-1

Update proguard task name constant

• Update GENERATE_PROGUARD_TASK_NAME constant from generateProguardRules to
 generateFeaturedProguardRules
• Namespace the task with featured prefix to prevent naming conflicts

featured-gradle-plugin/src/main/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPlugin.kt


2. featured-gradle-plugin/src/test/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPluginIntegrationTest.kt 🧪 Tests +8/-8

Update integration tests with new task name

• Update test method names to reference generateFeaturedProguardRules
• Update Gradle task arguments and assertions with new task name
• Update test documentation comments with new task name
• Update error messages and task outcome checks

featured-gradle-plugin/src/test/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPluginIntegrationTest.kt


3. featured-gradle-plugin/src/test/kotlin/dev/androidbroadcast/featured/gradle/GenerateProguardRulesTaskRegistrationTest.kt 🧪 Tests +5/-5

Update task registration tests with new name

• Update all test method names to reference generateFeaturedProguardRules
• Update test descriptions in Kotlin test function names
• Maintain constant usage GENERATE_PROGUARD_TASK_NAME in assertions

featured-gradle-plugin/src/test/kotlin/dev/androidbroadcast/featured/gradle/GenerateProguardRulesTaskRegistrationTest.kt


View more (5)
4. README.md 📝 Documentation +3/-3

Update README with new task name

• Update command example from generateProguardRules to generateFeaturedProguardRules
• Update task list in Configuration Cache section with new task name
• Update manual task execution documentation

README.md


5. docs/api/index.md 📝 Documentation +1/-1

Update API documentation task reference

• Update task table entry from generateProguardRules to generateFeaturedProguardRules
• Maintain task description and functionality documentation

docs/api/index.md


6. docs/guides/android.md 📝 Documentation +1/-1

Update Android guide with new task name

• Update manual task execution command from generateProguardRules to
 generateFeaturedProguardRules
• Update code example in Android guide

docs/guides/android.md


7. docs/guides/best-practices.md 📝 Documentation +1/-1

Update best practices guide task reference

• Update task command in best practices guide from generateProguardRules to
 generateFeaturedProguardRules
• Update code generation workflow documentation

docs/guides/best-practices.md


8. featured-gradle-plugin/CLAUDE.md 📝 Documentation +1/-1

Update CLAUDE.md task reference

• Update task name in task output table from generateProguardRules to
 generateFeaturedProguardRules
• Maintain output file path documentation

featured-gradle-plugin/CLAUDE.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Copy Markdown

qodo-code-review Bot commented May 17, 2026

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider


Action required

1. Missing changelog entry ✓ Resolved 🐞 Bug ⚙ Maintainability
Description
The plugin no longer registers a task named generateProguardRules (it is now
generateFeaturedProguardRules), so any existing CI/scripts invoking the old task will fail. This
breaking behavior change is not documented under ## Unreleased in docs/changelog.md, despite the
repo’s requirement to add a changelog entry per PR.
Code

featured-gradle-plugin/src/main/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPlugin.kt[10]

+internal const val GENERATE_PROGUARD_TASK_NAME = "generateFeaturedProguardRules"
Evidence
The plugin’s registered task name string is now generateFeaturedProguardRules, meaning
generateProguardRules is no longer created by the plugin. The changelog explicitly requires adding
an Unreleased entry per PR, but the Unreleased section has no entry describing this rename.

featured-gradle-plugin/src/main/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPlugin.kt[7-13]
docs/changelog.md[10-25]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The Gradle task rename is a breaking external-facing change, but `docs/changelog.md` has no entry under **Unreleased** documenting it.

### Issue Context
`FeaturedPlugin.kt` now registers the task name as `generateFeaturedProguardRules`. The changelog file states that each PR should add an Unreleased entry.

### Fix Focus Areas
- docs/changelog.md[10-33]
- featured-gradle-plugin/src/main/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPlugin.kt[7-13]

### Implementation notes
- Under `## Unreleased`, add a `### Changed` (or `### Removed` + `### Added`) bullet documenting: `generateProguardRules` → `generateFeaturedProguardRules`, and include a one-line migration note (update any scripts/CI invoking the old task).
- If you want extra safety, consider also documenting whether the old name is intentionally *not* kept as an alias due to task-name clash concerns.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Remediation recommended

2. Docs still use old task 🐞 Bug ⚙ Maintainability
Description
MkDocs does not exclude docs/specs/ or docs/cc-verification/, and those pages still reference
:generateProguardRules, which is no longer registered after this rename. Users can discover these
pages via site search/direct links and follow broken instructions inconsistent with the current task
name.
Code

featured-gradle-plugin/src/main/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPlugin.kt[10]

+internal const val GENERATE_PROGUARD_TASK_NAME = "generateFeaturedProguardRules"
Evidence
MkDocs is configured to exclude only superpowers/, so the docs/specs/ and
docs/cc-verification/ content is still part of the built docs site. Those pages contain
generateProguardRules, while the plugin now registers generateFeaturedProguardRules, creating
inconsistent/broken guidance.

mkdocs.yml[34-39]
docs/specs/2026-05-16-gradle-plugin-cc-support.md[54-56]
docs/cc-verification/agp-propagation-check-2026-05-16.md[113-122]
docs/cc-verification/fixture-report-2026-05-17.md[72-76]
featured-gradle-plugin/src/main/kotlin/dev/androidbroadcast/featured/gradle/FeaturedPlugin.kt[7-13]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
Some docs pages that appear to be historical/audit artifacts still mention the old task name `generateProguardRules`, but they are not excluded from the MkDocs build.

### Issue Context
The plugin now registers `generateFeaturedProguardRules`, while existing pages under `docs/specs/` and `docs/cc-verification/` still mention the old task name.

### Fix Focus Areas
- mkdocs.yml[34-66]
- docs/specs/2026-05-16-gradle-plugin-cc-support.md[54-56]
- docs/cc-verification/agp-propagation-check-2026-05-16.md[113-122]
- docs/cc-verification/fixture-report-2026-05-17.md[72-76]

### Implementation notes
Pick one:
1) Add `docs/specs/` and `docs/cc-verification/` to `exclude_docs:` in `mkdocs.yml`, or
2) Add a prominent “Historical snapshot” note at the top of those pages and update task-name mentions to `generateFeaturedProguardRules` (or explicitly explain the rename).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@kirich1409 kirich1409 requested a review from Copilot May 17, 2026 16:41
@kirich1409 kirich1409 self-assigned this May 17, 2026
@kirich1409 kirich1409 added this to the v1.0.0 milestone May 17, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Comment thread README.md Outdated
kirich1409 added a commit that referenced this pull request May 17, 2026
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.
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 9 files

Re-trigger cubic

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.
Copilot AI review requested due to automatic review settings May 18, 2026 06:45
@kirich1409 kirich1409 force-pushed the chore/rename-proguard-task branch from e11eeb5 to e7a3c66 Compare May 18, 2026 06:45
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated no new comments.

@kirich1409 kirich1409 merged commit 5b91709 into develop May 18, 2026
13 of 14 checks passed
@kirich1409 kirich1409 deleted the chore/rename-proguard-task branch May 18, 2026 07:00
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.

2 participants