wordpress-mobile / wordpress-mobile/WordPress-Android

Build errors after Installing the Relay Gradle plugin

Open
#18,317 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

[Type] Task Tech Debt
Dominant language
Kotlin
Stars
3.2k
Forks
1.4k
Avg merge
1d 11h
Merged PRs (30d)
69

Description

Expected behavior

Relay Gradle Plugin can be installed to the project and the project can be built with no errors afterwards.

Actual behavior

After installing the Relay Gradle Plugin, building the project fails with 100+ errors, all of them related to BuildConfig and usages of values from it in the app's source code.

Steps to reproduce the behavior
  1. Open the project in Android Studio
  2. Follow the official guide to Install the Relay Gradle plugin
  3. Tap Sync Now in Android Studio's notification bar that appears above the file editor
  4. Build/Make the project
  5. 💣 Verify the build fails with over 100 errors, all saying: Unresolved reference: BuildConfig
Example

Checkout the branch tech/relay-plugin to quickly see the issues.

Note
The tip of the branch is not trunk, but a rebase of trunk + deps/main-batch-androidx-compose-kotlin.
Due to this approach we should be able to check quickly if the pending Compose and related dependencies update doesn't improve something about this issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Check out the tech/relay-plugin branch, then follow the documented Relay Gradle plugin installation steps and run a Gradle sync and project build. Investigate the resulting BuildConfig unresolved-reference errors; the work is done when the plugin is installed and the project builds without those errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, kotlin
Domain
build-system, mobile
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.