Add `android_prune_orphaned_translations` action by oguzkocer · Pull Request #734 · wordpress-mobile/release-toolkit

oguzkocer · 2026-06-17T21:48:15Z

What does it do?

Adds an android_prune_orphaned_translations action that removes orphaned translations from downloaded locale files, so they don't trip Android Lint's ExtraTranslation rule.

When translations are downloaded from GlotPress, the export can include keys that are no longer in the app's source strings (removed or renamed since the GlotPress source was last synced).

For every values-*/strings.xml under res_dir, the action removes any <string>, <string-array> or <plurals> whose name is not declared in the source strings — the res dir's default values/strings.xml, optionally unioned with additional_source_strings_paths (for flavors that overlay a base module's resources at build time). It re-serializes with the same options the download uses, so the change is a minimal diff.

android_prune_orphaned_translations(
  res_dir: 'WordPress/src/jetpack/res',
  additional_source_strings_paths: ['WordPress/src/main/res/values/strings.xml']
)

Checklist before requesting a review

Run bundle exec rubocop to test for code style violations and recommendations.
Add Unit Tests (aka specs/*_spec.rb) if applicable.
Run bundle exec rspec to run the whole test suite and ensure all your tests pass.
Make sure you added an entry in the CHANGELOG.md file to describe your changes under the appropriate existing ### subsection of the existing ## Trunk section.
If applicable, add an entry in the MIGRATION.md file to describe how the changes will affect the migration from the previous major version and what the clients will need to change and consider.

Removes <string>/<string-array>/<plurals> entries from values-*/strings.xml whose key is not declared in the source strings (the res dir's default values/strings.xml, optionally unioned with additional_source_strings_paths). Useful after downloading translations from GlotPress to avoid Lint ExtraTranslation errors from keys removed/renamed since the source was synced.

Copilot

Pull request overview

Adds a new Fastlane Android action to remove orphaned resource entries from downloaded values-*/strings.xml locale files, preventing Android Lint ExtraTranslation errors after GlotPress exports include stale keys.

Changes:

Introduces android_prune_orphaned_translations action that computes valid keys from source values/strings.xml (+ optional additional sources) and prunes invalid entries from locale files.
Adds RSpec coverage for pruning behavior, including the “additional source strings” overlay case.
Documents the new action in CHANGELOG.md.

Reviewed changes

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

File	Description
`lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_prune_orphaned_translations_action.rb`	Implements the new pruning action using Nokogiri XML parsing/serialization.
`spec/android_prune_orphaned_translations_spec.rb`	Adds unit tests validating pruning behavior and reporting counts.
`CHANGELOG.md`	Adds a Trunk entry describing the new action and its intent.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Add explicit `require 'fileutils'` to the spec (matches existing specs and is robust if spec_helper's transitive load changes). Declined the suggested `require 'set'` in the action: Set is autoloaded on Ruby >= 3.2 (the gem's floor) and rubocop's Lint/RedundantRequireStatement would reject it.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

mokagio · 2026-06-26T01:44:28Z

+          FastlaneCore::ConfigItem.new(
+            key: :res_dir,
+            description: "Path to the Android project's `res` directory containing the `values-*` locale subdirectories to prune",
+            type: String,
+            optional: false
+          ),


Seems like a reasonable suggestion.

mokagio · 2026-06-26T02:03:00Z

+          FastlaneCore::ConfigItem.new(
+            key: :additional_source_strings_paths,
+            description: 'Paths to additional default `strings.xml` files whose keys should also be treated as valid ' \
+                         '(e.g. a base module that the pruned `res_dir` overlays at build time)',
+            type: Array,
+            optional: true,
+            default_value: []
+          ),


This also seems like a good addition.

+        source_paths = [File.join(res_dir, 'values', 'strings.xml')] + params[:additional_source_strings_paths]
+        valid_keys = collect_keys(source_paths)
+
+        locale_files = Dir.glob(File.join(res_dir, 'values-*', 'strings.xml'))


Restrict the glob to Android locale-qualifier directories (language, optional region, or BCP-47 b+ form) so non-locale qualifier dirs like values-night or values-v21 are left untouched. Addresses Copilot review on #734.

Fail with a user-facing message when the res dir's default values/strings.xml or any additional_source_strings_paths entry is missing, instead of a low-level Errno::ENOENT. Addresses Copilot review on #734.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

 ### New Features

-_None_
+- Added `android_prune_orphaned_translations` action: removes `<string>`, `<string-array>` and `<plurals>` entries from `values-*/strings.xml` whose key is not declared in the source strings (the res dir's default `values/strings.xml`, optionally unioned with `additional_source_strings_paths`). Useful after downloading translations from GlotPress to avoid Lint `ExtraTranslation` errors from keys removed/renamed since the source was last synced.


mokagio · 2026-06-26T01:58:37Z

+      LOCALE_VALUES_DIR_REGEX = /\Avalues-(?:b\+[a-zA-Z]+(?:\+[a-zA-Z0-9]+)*|[a-z]{2,3}(?:-r(?:[A-Z]{2}|\d{3}))?)\z/
+
+      def self.run(params)
+        res_dir = params[:res_dir]
+        source_paths = [File.join(res_dir, 'values', 'strings.xml')] + params[:additional_source_strings_paths]


Nitpick. The relative path values/strings.xml appear a number of times. Have you considered DRYing it? Example:

Suggested change

LOCALE_VALUES_DIR_REGEX = /\Avalues-(?:b\+[a-zA-Z]+(?:\+[a-zA-Z0-9]+)*|[a-z]{2,3}(?:-r(?:[A-Z]{2}|\d{3}))?)\z/

def self.run(params)

res_dir = params[:res_dir]

source_paths = [File.join(res_dir, 'values', 'strings.xml')] + params[:additional_source_strings_paths]

LOCALE_VALUES_DIR_REGEX = /\Avalues-(?:b\+[a-zA-Z]+(?:\+[a-zA-Z0-9]+)*|[a-z]{2,3}(?:-r(?:[A-Z]{2}|\d{3}))?)\z/

DEFAULT_SOURCE_STRINGS_FILE_NAME = 'strings.xml'

DEFAULT_SOURCE_STRINGS_RELATIVE_PATH = File.join('values', DEFAULT_SOURCE_STRINGS_FILE_NAME)

def self.run(params)

res_dir = params[:res_dir]

source_paths = [File.join(res_dir, DEFAULT_SOURCE_STRINGS_RELATIVE_PATH)] + params[:additional_source_strings_paths]

mokagio · 2026-06-26T02:00:10Z

+        end
+        valid_keys = collect_keys(source_paths)
+
+        locale_files = Dir.glob(File.join(res_dir, 'values-*', 'strings.xml')).select do |file|


Following up on my nitpick above

Suggested change

locale_files = Dir.glob(File.join(res_dir, 'values-*', 'strings.xml')).select do |file|

locale_files = Dir.glob(File.join(res_dir, 'values-*', DEFAULT_SOURCE_STRINGS_FILE_NAME)).select do |file|

mokagio · 2026-06-26T02:01:34Z

+      #####################################################
+
+      def self.description
+        'Removes translations whose key is not present in the source strings, to avoid Lint `ExtraTranslation` errors'


Nitpick. (At least, I think this is the correct grammar)

Suggested change

'Removes translations whose key is not present in the source strings, to avoid Lint `ExtraTranslation` errors'

'Removes translations whose keys are not present in the source strings, to avoid Lint `ExtraTranslation` errors'

mokagio · 2026-06-26T02:06:43Z

 ### New Features

-_None_
+- Added `android_prune_orphaned_translations` action: removes `<string>`, `<string-array>` and `<plurals>` entries from `values-*/strings.xml` whose key is not declared in the source strings (the res dir's default `values/strings.xml`, optionally unioned with `additional_source_strings_paths`). Useful after downloading translations from GlotPress to avoid Lint `ExtraTranslation` errors from keys removed/renamed since the source was last synced. [#734]


Formatting nitpick. This is my personal opinion, but I find the long changelog entries AI makes noisy. I find the kind of shorter entries we used to make manually easier to read. Or, rather, I find these AI-generated ones easier to gloss over without taking them in.

Suggested change

- Added `android_prune_orphaned_translations` action: removes `<string>`, `<string-array>` and `<plurals>` entries from `values-*/strings.xml` whose key is not declared in the source strings (the res dir's default `values/strings.xml`, optionally unioned with `additional_source_strings_paths`). Useful after downloading translations from GlotPress to avoid Lint `ExtraTranslation` errors from keys removed/renamed since the source was last synced. [#734]

- `android_prune_orphaned_translations` action: removes `<string>`, `<string-array>` and `<plurals>` entries from `values-*/strings.xml` whose keys are not declared in the source `values/strings.xml optionally unioned with `additional_source_strings_paths`. [#734]

mokagio

Looking good. Thanks you for implementing this and your other recent work in the tool. Brought me back to the old days...

I left a few of suggestions and nitpicks. I'm happy for this to land as is and to follow up on those myself if it speeds along adoption in WordPress Android.

mokagio · 2026-06-26T03:12:24Z

+      # Matches an Android `values-<qualifier>` directory whose qualifier is a locale (a language code, optional
+      # region, or a BCP-47 `b+` form), so non-locale qualifier dirs (e.g. `values-night`, `values-v21`,
+      # `values-land`) are left untouched.
+      LOCALE_VALUES_DIR_REGEX = /\Avalues-(?:b\+[a-zA-Z]+(?:\+[a-zA-Z0-9]+)*|[a-z]{2,3}(?:-r(?:[A-Z]{2}|\d{3}))?)\z/


My AI noticed that values-car would pass this RegEx despite not being a valid locale folder.

I'm not familiar with how values- work in Android, but I asked for documentation and this came up: https://developer.android.com/guide/topics/resources/providing-resources#UiModeQualifier where car is listed as a qualifier for UI mode.

There's a test showing this limitation at https://github.com/wordpress-mobile/release-toolkit/pull/746/changes#diff-fc5d87ba15967a529eaa6080f6bc0f2313e7133e68f21204d26a76aee6540154R92-R110

I don't consider this a blocker to merging because we know that the action will be used on WordPress Android first, which does not have a car version.

oguzkocer added the enhancement New feature or request label Jun 17, 2026

oguzkocer marked this pull request as ready for review June 17, 2026 22:44

oguzkocer requested a review from a team as a code owner June 17, 2026 22:44

mokagio requested a review from Copilot June 18, 2026 01:28

Copilot started reviewing on behalf of mokagio June 18, 2026 01:28 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Comment thread ...tlane/plugin/wpmreleasetoolkit/actions/android/android_prune_orphaned_translations_action.rb

Comment thread spec/android_prune_orphaned_translations_spec.rb

oguzkocer requested a review from Copilot June 18, 2026 13:22

Copilot started reviewing on behalf of oguzkocer June 18, 2026 13:22 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

oguzkocer added 2 commits June 18, 2026 09:39

Only prune locale qualifier dirs, not values-night/v21/etc.

efb03cc

Restrict the glob to Android locale-qualifier directories (language, optional region, or BCP-47 b+ form) so non-locale qualifier dirs like values-night or values-v21 are left untouched. Addresses Copilot review on #734.

Validate source strings paths with a clear error

e7789a4

Fail with a user-facing message when the res dir's default values/strings.xml or any additional_source_strings_paths entry is missing, instead of a low-level Errno::ENOENT. Addresses Copilot review on #734.

oguzkocer requested a review from Copilot June 18, 2026 14:15

Copilot started reviewing on behalf of oguzkocer June 18, 2026 14:15 View session

Copilot AI reviewed Jun 18, 2026

View reviewed changes

Add PR reference to the CHANGELOG entry [#734]

b6ac1db

mokagio mentioned this pull request Jun 26, 2026

Add values-car pruning regression test #746

Open

5 tasks

mokagio reviewed Jun 26, 2026

View reviewed changes

mokagio approved these changes Jun 26, 2026

View reviewed changes

	locale_files = Dir.glob(File.join(res_dir, 'values-*', 'strings.xml')).select do \|file\|
	locale_files = Dir.glob(File.join(res_dir, 'values-*', DEFAULT_SOURCE_STRINGS_FILE_NAME)).select do \|file\|

	'Removes translations whose key is not present in the source strings, to avoid Lint `ExtraTranslation` errors'
	'Removes translations whose keys are not present in the source strings, to avoid Lint `ExtraTranslation` errors'

Uh oh!

Conversation

oguzkocer commented Jun 17, 2026

What does it do?

Checklist before requesting a review

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

mokagio Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

mokagio Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

mokagio Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mokagio Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

mokagio Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

mokagio Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

mokagio left a comment

Choose a reason for hiding this comment

Uh oh!

mokagio Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mokagio Jun 26, 2026 •

edited

Loading