SCRUM-269 build: Configure product flavors#58
Merged
gdaegeun539 merged 3 commits intoJun 12, 2026
Merged
Conversation
Introduce 'dev', 'staging', and 'prod' product flavors to separate development, QA, and production environments. Dynamic configuration includes custom application IDs, base URLs, and Kakao API keys. - Define 'environment' flavor dimension with dev, staging, prod flavors - Set up conditional Kakao key verification depending on Gradle tasks - Update CI workflow to build flavor-specific outputs - Inject BASE_URL dynamically and replace hardcoded value in NetworkModule - Add tests to verify build configurations across flavors
📝 WalkthroughWalkthroughThis PR refactors the Android build to support dev, staging, and prod flavors: per-flavor Kakao key resolution and BuildConfig injection, flavor-specific app names and applicationIds, Retrofit wired to BuildConfig.BASE_URL, CI build step adjustments, and tests validating per-flavor BuildConfig values. ChangesMulti-Flavor Build Architecture
Sequence Diagram(s)sequenceDiagram
participant CI as GitHub Actions
participant Gradle as Gradle Daemon
participant BuildConfig as BuildConfig
participant App as Android App
CI->>Gradle: trigger assembleDevDebug / assembleStaging* / assembleProd*
Gradle->>Gradle: detect requested flavor (requestedTasksMentionFlavor / aggregate detection)
Gradle->>Gradle: resolve kakaoNativeAppKey from local.properties or env
Gradle->>BuildConfig: inject BASE_URL and KAKAO_NATIVE_APP_KEY per flavor
App->>BuildConfig: read BASE_URL / KAKAO_NATIVE_APP_KEY at runtime
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3d78920b12
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
local.properties.example (3)
2-4: ⚡ Quick winAdd developer guidance comments to improve onboarding experience.
The example file would benefit from comments explaining:
- Where developers can obtain Kakao native app keys
- That environment variables can be used as fallback (e.g.,
KAKAO_NATIVE_APP_KEY_DEV)- That builds will fail if keys are missing for the requested flavor
This documentation would significantly reduce setup friction for new developers joining the project.
📝 Proposed improvement with developer guidance
+# Kakao native app keys for each environment +# Obtain these keys from Kakao Developers Console (https://developers.kakao.com/) +# Alternatively, you can set environment variables: +# KAKAO_NATIVE_APP_KEY_DEV, KAKAO_NATIVE_APP_KEY_STAGING, KAKAO_NATIVE_APP_KEY_PROD +# Note: Builds will fail if the key is missing for the flavor you're building kakao.native.app.key.dev=KAKAO_DEV_NATIVE_APP_KEY_HERE kakao.native.app.key.staging=KAKAO_QA_NATIVE_APP_KEY_HERE kakao.native.app.key.prod=KAKAO_PROD_NATIVE_APP_KEY_HERE🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@local.properties.example` around lines 2 - 4, Add brief inline comments above the kakao.native.app.key.* entries explaining where to obtain Kakao native app keys (link to Kakao developers console), note that environment variables (e.g., KAKAO_NATIVE_APP_KEY_DEV, KAKAO_NATIVE_APP_KEY_STAGING, KAKAO_NATIVE_APP_KEY_PROD) can be used as fallbacks, and warn that builds will fail for a requested flavor if the corresponding key (kakao.native.app.key.dev / kakao.native.app.key.staging / kakao.native.app.key.prod) is missing; place these comments near those exact property names so new devs see the guidance when opening local.properties.example.
1-1: ⚡ Quick winClarify the
sdk.dirplaceholder to reduce setup confusion.The current placeholder text "WILL_BE_AUTOMATICALLY_CREATED" may confuse developers about whether they need to manually set this value. Android Studio typically creates this entry automatically when opening the project.
Consider either:
- Adding a comment explaining this is auto-generated by Android Studio
- Providing an OS-specific example path (e.g.,
/Users/yourname/Library/Android/sdkfor macOS)- Omitting this line entirely since it's auto-generated
📝 Proposed improvement with explanatory comment
+# sdk.dir is automatically set by Android Studio when you open the project +# If needed, set it to your Android SDK path, e.g.: +# sdk.dir=/Users/yourname/Library/Android/sdk (macOS) +# sdk.dir=C:\\Users\\YourName\\AppData\\Local\\Android\\Sdk (Windows) -sdk.dir=YOUR_ANDROID_SDK_DIR_WILL_BE_AUTOMATICALLY_CREATED🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@local.properties.example` at line 1, Update local.properties.example to clarify the sdk.dir placeholder: replace "YOUR_ANDROID_SDK_DIR_WILL_BE_AUTOMATICALLY_CREATED" with a short comment that Android Studio typically generates this entry (e.g., "# Android Studio will auto-create this file on first open"), and include optional OS-specific example paths (macOS: /Users/yourname/Library/Android/sdk, Linux: /home/yourname/Android/Sdk, Windows: C:\Users\yourname\AppData\Local\Android\Sdk) or simply remove the sdk.dir line if you prefer to avoid shipping a placeholder; ensure the file clearly states it is an example and should not be committed with real credentials/paths.
3-3: 💤 Low valueConsider using "STAGING" instead of "QA" for consistency.
The placeholder uses "KAKAO_QA_NATIVE_APP_KEY_HERE", but the flavor is named "staging" throughout the codebase. While the staging app displays "[QA] Feelin", using "STAGING" in the placeholder would be more consistent with the property key
kakao.native.app.key.staging.♻️ Proposed consistency improvement
-kakao.native.app.key.staging=KAKAO_QA_NATIVE_APP_KEY_HERE +kakao.native.app.key.staging=KAKAO_STAGING_NATIVE_APP_KEY_HERE🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@local.properties.example` at line 3, Update the placeholder value for the staging Kakao native app key to match the "staging" flavor naming: replace the current placeholder "KAKAO_QA_NATIVE_APP_KEY_HERE" referenced alongside the property key kakao.native.app.key.staging with a "STAGING" variant (e.g., "KAKAO_STAGING_NATIVE_APP_KEY_HERE") so the placeholder is consistent with the staging flavor used throughout the codebase.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/android-ci.yml:
- Around line 78-87: CI currently builds only dev and staging flavors (tasks
assembleDevDebug, assembleStagingDebug, assembleStagingRelease), so prod flavor
wiring isn't validated; add equivalent GitHub Actions steps that run ./gradlew
:app:assembleProdDebug --no-daemon --stacktrace (and optionally
:app:assembleProdRelease) with the same conditionals as staging (e.g., on push
to develop or on push to main/production branch as appropriate) to ensure the
prod BuildConfig/manifest/resources are compiled in CI.
In `@app/build.gradle.kts`:
- Line 99: The buildConfigField("String", "BASE_URL", ...) is set to an insecure
HTTP URL; change the value to use HTTPS (e.g., "https://api.feelinapp.com/") in
the build.gradle.kts so production traffic uses TLS, and update the expected
string in the test (FlavorBuildConfigTest.kt) to match the new HTTPS value so
tests continue to pass.
- Around line 22-46: requestedTasksContainFlavor currently uses substring
matching which allows aggregate tasks to bypass Kakao key validation; update
requestedTasksContainFlavor so it only returns true when the flavor is actually
present as a distinct task token or as a concrete variant token (e.g., matches
assemble<Flavor>, install<Flavor> or a colon-separated flavor segment), not
merely as a substring. Concretely, change requestedTasksContainFlavor to iterate
gradle.startParameter.taskNames and use a case-insensitive regex or
token-splitting logic to detect exact flavor occurrences (match patterns like
":...:assembleFlavor", ":...:installFlavor", or a colon-separated flavor
segment) and keep kakaoNativeAppKey using this tightened function for
validation.
---
Nitpick comments:
In `@local.properties.example`:
- Around line 2-4: Add brief inline comments above the kakao.native.app.key.*
entries explaining where to obtain Kakao native app keys (link to Kakao
developers console), note that environment variables (e.g.,
KAKAO_NATIVE_APP_KEY_DEV, KAKAO_NATIVE_APP_KEY_STAGING,
KAKAO_NATIVE_APP_KEY_PROD) can be used as fallbacks, and warn that builds will
fail for a requested flavor if the corresponding key (kakao.native.app.key.dev /
kakao.native.app.key.staging / kakao.native.app.key.prod) is missing; place
these comments near those exact property names so new devs see the guidance when
opening local.properties.example.
- Line 1: Update local.properties.example to clarify the sdk.dir placeholder:
replace "YOUR_ANDROID_SDK_DIR_WILL_BE_AUTOMATICALLY_CREATED" with a short
comment that Android Studio typically generates this entry (e.g., "# Android
Studio will auto-create this file on first open"), and include optional
OS-specific example paths (macOS: /Users/yourname/Library/Android/sdk, Linux:
/home/yourname/Android/Sdk, Windows:
C:\Users\yourname\AppData\Local\Android\Sdk) or simply remove the sdk.dir line
if you prefer to avoid shipping a placeholder; ensure the file clearly states it
is an example and should not be committed with real credentials/paths.
- Line 3: Update the placeholder value for the staging Kakao native app key to
match the "staging" flavor naming: replace the current placeholder
"KAKAO_QA_NATIVE_APP_KEY_HERE" referenced alongside the property key
kakao.native.app.key.staging with a "STAGING" variant (e.g.,
"KAKAO_STAGING_NATIVE_APP_KEY_HERE") so the placeholder is consistent with the
staging flavor used throughout the codebase.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: c0827323-4084-427c-9b6e-c099e04332fb
📒 Files selected for processing (9)
.github/workflows/android-ci.ymlapp/build.gradle.ktsapp/src/androidTest/java/com/lyrics/feelin/ExampleInstrumentedTest.ktapp/src/dev/res/values/strings.xmlapp/src/main/java/com/lyrics/feelin/core/data/di/NetworkModule.ktapp/src/prod/res/values/strings.xmlapp/src/staging/res/values/strings.xmlapp/src/test/java/com/lyrics/feelin/FlavorBuildConfigTest.ktlocal.properties.example
Configure the CI pipeline to run production debug and release builds when pushing to the main branch. Also define the KAKAO_NATIVE_APP_KEY_PROD environment variable with a fallback dummy key for CI compile checks. - Add KAKAO_NATIVE_APP_KEY_PROD to workflow env block - Create 'Build prod debug' step triggered on push to main - Create 'Build prod release' step triggered on push to main
Update app/build.gradle.kts to verify the Kakao native app key not only for specific flavor tasks, but also for aggregate Gradle tasks (like assemble, build, check) that compile those flavors. - Refactor task verification to use regex for precise matching - Add shouldRequireKakaoNativeAppKey to detect aggregate builds
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/workflows/android-ci.yml (1)
90-96: 💤 Low valueConsider adding prod build validation on PRs to main.
Currently, PRs targeting
mainonly runassembleDevDebug. Prod-specific wiring issues (BuildConfig fields, manifest placeholders, resources) won't surface until after the merge. If fail-fast validation before merge is desired, consider adding a conditional prod build for PRs to main:- name: Build prod debug if: github.event_name == 'push' && github.ref == 'refs/heads/main' || github.event_name == 'pull_request' && github.base_ref == 'main' run: ./gradlew :app:assembleProdDebug --no-daemon --stacktraceThis is optional if the current workflow (validate prod only at merge time) is intentional.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/android-ci.yml around lines 90 - 96, Update the job conditionals for the "Build prod debug" (and optionally "Build prod release") steps so they run not only on direct pushes to main but also for pull requests targeting main by including github.event_name == 'pull_request' && github.base_ref == 'main' in the if expression; locate the steps named "Build prod debug" and "Build prod release" and change their if conditions to combine the existing push-to-main check with the pull_request-to-main check so assembleProdDebug (and assembleProdRelease if desired) runs for PRs against main as well.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.github/workflows/android-ci.yml:
- Around line 90-96: Update the job conditionals for the "Build prod debug" (and
optionally "Build prod release") steps so they run not only on direct pushes to
main but also for pull requests targeting main by including github.event_name ==
'pull_request' && github.base_ref == 'main' in the if expression; locate the
steps named "Build prod debug" and "Build prod release" and change their if
conditions to combine the existing push-to-main check with the
pull_request-to-main check so assembleProdDebug (and assembleProdRelease if
desired) runs for PRs against main as well.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 6b75da01-613b-4486-a52a-867a408a2c2e
📒 Files selected for processing (2)
.github/workflows/android-ci.ymlapp/build.gradle.kts
Member
Author
|
@codex review |
|
Codex Review: Didn't find any major issues. Delightful! ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Member
Author
|
AI 에이전트 코드리뷰에서 큰 문제가 발견되지 않았으므로 병합하겠습니다. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce?
What is the current behavior?
기존에는 단일 빌드 variant만 존재하여 dev/staging/prod 환경 분리가 불가능했습니다.
Kakao native app key와 base URL이 하드코딩되어 있었습니다.
What is the new behavior (if this is a feature change)?
Android product flavor를 3가지 환경(dev/staging/prod)으로 분리합니다.
주요 변경사항:
Product Flavors 추가
dev:com.lyrics.feelin.dev— 개발 환경staging:com.lyrics.feelin.qa— QA 환경prod:com.lyrics.feelin— 운영 환경Flavor별 설정
applicationIdBASE_URL(dev/staging:dev.feelinapp.com, prod:api.feelinapp.com)kakao.native.app.key.{dev,staging,prod})[DEV] Feelin,[QA] Feelin,Feelin)Build 설정 개선
local.properties.example추가NetworkModule이BuildConfig.BASE_URL을 사용하도록 변경CI 업데이트
assembleDevDebug빌드 검증stagingDebug+stagingRelease추가 빌드테스트 추가
FlavorBuildConfigTest: flavor별 APPLICATION_ID, BASE_URL 검증ExampleInstrumentedTest: flavor별 packageName assertion 지원Does this PR introduce a breaking change?
local.properties에kakao.native.app.key.staging과kakao.native.app.key.prod를 추가해야 합니다../gradlew :app:assembleDebug→./gradlew :app:assembleDevDebug로 변경되었습니다.ScreenShots
Other information:
Summary by CodeRabbit
New Features
Tests
Chores