Skip to content

Improve remote config patches documentation#7932

Merged
LukasPaczos merged 7 commits intodevelopfrom
feature/lukasz-p/improve-config-patch-docs
Mar 12, 2026
Merged

Improve remote config patches documentation#7932
LukasPaczos merged 7 commits intodevelopfrom
feature/lukasz-p/improve-config-patch-docs

Conversation

@LukasPaczos
Copy link
Contributor

@LukasPaczos LukasPaczos commented Mar 10, 2026

Task/Issue URL: https://app.asana.com/1/137249556945/project/1208671518894266/task/1213611390820529?focus=true

Description

  • Rewrites the README for conciseness and readability; adds a Quick Start section
  • Adds build variant warning (patches only work in internal builds)
  • Documents patch ordering, conflict resolution, and failure behaviour
  • Adds "Writing a patch file" section with examples for overriding feature state, sub-features, and adding new sub-features
  • Clarifies when the full patch (hash removal + version bump) is needed vs. a simple state override
  • Adds "Verifying a patch was applied" section covering Gradle build output and logcat
  • Restructures usage: local dev via local.properties vs. committed patches via -Pconfig_patches flag
  • Adds Maestro test file layout example and end-to-end build+test workflow
  • Adds GitHub Actions workflow example using checkout-and-assemble gradle_flags input
  • Adds PR review workflow: how to share patch files in a PR description so reviewers can verify feature flag states step by step
  • Adds patch examples section with full before/after config for common scenarios

Steps to test this PR

  • Read through the updated README and verify accuracy
  • Verify the Maestro and GitHub Actions examples match existing workflow patterns in the repo

🤖 Generated with Claude Code

@LukasPaczos LukasPaczos force-pushed the feature/lukasz-p/improve-config-patch-docs branch from dbc191e to 2a3d0be Compare March 11, 2026 07:03
@LukasPaczos LukasPaczos force-pushed the feature/lukasz-p/improve-config-patch-docs branch from b3227c9 to c658f00 Compare March 11, 2026 13:57
@LukasPaczos LukasPaczos requested review from GerardPaligot and removed request for anikiki and malmstein March 11, 2026 13:57
Copy link
Contributor

@GerardPaligot GerardPaligot left a comment

Choose a reason for hiding this comment

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

The new versioning value and concrete examples with sub features are really nice improvements!

@LukasPaczos LukasPaczos force-pushed the feature/lukasz-p/improve-config-patch-docs branch from 1d33d84 to 1e115b3 Compare March 12, 2026 09:02
@LukasPaczos
Copy link
Contributor Author

LukasPaczos commented Mar 12, 2026

Thanks for taking a look @GerardPaligot! I gave this another pass, incorporated your ideas, and re-did the structure to keep it more concise at the top and add more examples at the bottom.

This is ready for another round.

Copy link
Contributor

@GerardPaligot GerardPaligot left a comment

Choose a reason for hiding this comment

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

LGTM!

@LukasPaczos LukasPaczos merged commit 23f6609 into develop Mar 12, 2026
14 checks passed
@LukasPaczos LukasPaczos deleted the feature/lukasz-p/improve-config-patch-docs branch March 12, 2026 13:15
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