Use Lokalise action and async download by TimoPtr · Pull Request #6659 · home-assistant/android

TimoPtr · 2026-03-30T16:34:46Z

Summary

Since today we are facing a 413 error on Lokalize and the recommend way to download big projects is to use the Async way. Fortunately they have a Github Action that can do that for us.

I've made a dumb commit to show that the French translations were properly downloaded in the right place.

A new job has been added to the PR workflow that run only if the .github/actions/download-translations has a change. We use a fake Github token to make sure that if one day the behavior of the action changes we catch it when Renovate opens a PR. This job will start and stop if no modification are made so that we can have a Github checks on the PR.

Checklist

New or updated tests have been added to cover the changes following the testing guidelines.
The code follows the project's code style and best_practices.
The changes have been thoroughly tested, and edge cases have been considered.
Changes are backward compatible whenever feasible. Any breaking changes are documented in the changelog for users and/or in the code for developers depending on the relevance.

Any other notes

Zizmor is not reporting any issue

Copilot

Pull request overview

Updates the CI translation download mechanism to use Lokalise’s async export via a GitHub Action (to avoid 413 errors) and wires translation download into the PR workflow.

Changes:

Replace custom curl-based Lokalise download with lokalise/lokalise-pull-action using async_mode
Add “Download Translations” step to the PR workflow (yamllint job)
Add temporary debug output to print generated locale config and a downloaded translation file

Reviewed changes

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

File	Description
.github/workflows/pr.yml	Adds translation download step (with secrets) to PR CI before yamllint
.github/actions/download-translations/action.yml	Switches translation download implementation to Lokalise pull action with async export params

Comments suppressed due to low confidence (1)

.github/actions/download-translations/action.yml:51

These cat debug prints (generated locales_config + full French strings file) will bloat workflow logs and can easily exceed log limits as translations grow. Please remove them (or gate behind an explicit debug flag) once the download path is validated.

        echo "Complete"

jpelgrom · 2026-03-30T17:26:52Z

This may work but looking at the suggested use cases in the action README it should be used to sync translations to the repository, and the action also has a lot of functionality to automatically create pull requests etc. We may end up with issues in the future, what do you think?

Edit: also shown by the log for the action test run 'no changes detected'.

Downloading translation files from Lokalise...
Starting download from Lokalise
Download complete! Detecting changed files...
No changes detected in translation files.
No changes detected, nothing to commit.

jpelgrom · 2026-03-30T17:27:40Z

.github/actions/download-translations/action.yml

+          {
+            "original_filenames": false,
+            "bundle_structure": "common/src/main/res/values-%LANG_ISO%/strings.%FORMAT%",
+            "add_newline_eof": true,
+            "replace_breaks": true,
+            "export_empty_as": "skip"
+          }


This can be yaml which I think should be preferred when using a 'native' action instead of mixing in JSON?

I'll do it tomorrow or feel free to push on my branch if you want to merge it.

TimoPtr · 2026-03-30T17:42:59Z

This may work but looking at the suggested use cases in the action README it should be used to sync translations to the repository, and the action also has a lot of functionality to automatically create pull requests etc. We may end up with issues in the future, what do you think?

Edit: also shown by the log for the action test run 'no changes detected'.
Downloading translation files from Lokalise...
Starting download from Lokalise
Download complete! Detecting changed files...
No changes detected in translation files.
No changes detected, nothing to commit.

I saw it too but to do the comparaison they need to download so I think we should be fine and it is a simple wrapper around the API. In the worse case we would fallback to the CLI.

jpelgrom · 2026-03-30T18:02:30Z

I saw it too but to do the comparaison they need to download so I think we should be fine and it is a simple wrapper around the API. In the worse case we would fallback to the CLI.

I'd like to avoid the possibility of it (accidentally) doing more in the future with an update though 🤔 We can specify custom_github_token and pass a false token to prevent it from doing any Git operations, or is that too much ? (In the workflows where it's used the token only has contents permission, but still.)

TimoPtr · 2026-03-30T18:21:45Z

I saw it too but to do the comparaison they need to download so I think we should be fine and it is a simple wrapper around the API. In the worse case we would fallback to the CLI.

I'd like to avoid the possibility of it (accidentally) doing more in the future with an update though 🤔 We can specify custom_github_token and pass a false token to prevent it from doing any Git operations, or is that too much ? (In the workflows where it's used the token only has contents permission, but still.)

What about pulling the translation and make some assertions like is the french translations present? We could maybe do it on every commit or make it something we can start manually so when a new version is released we can trigger it before reaching main.

jpelgrom · 2026-03-30T18:30:29Z

If we start doing so much work to verify it might be easier to just use the CLI already...

... but your solution would work to make sure that it continues downloading the files and not discard them immediately 👍. My point is still stands to avoid it doing Git(Hub) operations that reach GitHub.

TimoPtr · 2026-03-30T18:32:51Z

If we start doing so much work to verify it might be easier to just use the CLI already...

... but your solution would work to make sure that it continues downloading the files and not discard them immediately 👍. My point is still stands to avoid it doing Git(Hub) operations that reach GitHub.

The CLI is annoying me a bit because we would need to make something custom for renovate to catch up the version of the CLI that we get with curl or we would use 'main' and I don't like not having a reproductible build.

I'll try your idea about the token it's a good one. When do you think it should run?

jpelgrom · 2026-03-30T18:35:51Z

I'll try your idea about the token it's a good one. When do you think it should run?

I'm presuming the question doesn't relate to the previous sentence because otherwise it's very confusing. Your suggested 'translation file exists' check: workflow scoped to when the download-translations file (action) changes, which happens on updates of Lokalise GitHub action but prevents it from running in other scenarios.

TimoPtr · 2026-03-30T18:39:13Z

I'll try your idea about the token it's a good one. When do you think it should run?

I'm presuming the question doesn't relate to the previous sentence because otherwise it's very confusing. Your suggested 'translation file exists' check: workflow scoped to when the download-translations file (action) changes, which happens on updates of Lokalise GitHub action but prevents it from running in other scenarios.

Indeed sorry for the confusion. Not sure I can do that, is it an issue to do it on the PR workflow?

jpelgrom · 2026-03-30T18:57:08Z

Not sure I can do that, is it an issue to do it on the PR workflow?

You can do it on PR with the paths option.

On every PR run could also work, I was just trying to be mindful of Lokalise API usage.

TimoPtr · 2026-03-31T07:55:07Z

@jpelgrom once this is merged if they break something in the action we should be able to see it.

Copilot

Pull request overview

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

Copilot · 2026-03-31T07:59:26Z

.github/workflows/pr.yml

+  validate_localize_setup:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Check for Lokalize setup changes
+        id: changes
+        shell: bash
+        run: |
+          if git diff --name-only "${{ github.event.pull_request.base.sha }}..HEAD" -- '.github/actions/download-translations/' | grep -q .; then
+            echo "Lokalize setup changes detected"
+            echo "skip=false" >> "$GITHUB_OUTPUT"


validate_localize_setup runs on workflow_dispatch as well as pull_request, but it unconditionally references github.event.pull_request.base.sha. For workflow_dispatch this field is missing and the git diff step will fail. Consider guarding the job/step with if: github.event_name == 'pull_request', or using a fallback base ref/sha for manual runs (e.g., diff against origin/main).

.github/workflows/pr.yml

Copilot · 2026-03-31T07:59:27Z

.github/actions/download-translations/action.yml

+      uses: lokalise/lokalise-pull-action@a4968e06b7f44c32317b162d825ed17abb5772d0 # v5.0.1
+      with:
+        api_token: ${{ inputs.lokalise-token }}
+        project_id: ${{ inputs.lokalise-project }}
+        custom_github_token: "FAKE_GH_TOKEN"
+        file_format: xml
+        async_mode: true
+        skip_include_tags: true
+        skip_original_filenames: true


The composite action hardcodes custom_github_token: "FAKE_GH_TOKEN". This action is also used by other workflows (e.g., release/on-push builds), so hardcoding an invalid token can break those pipelines if the Lokalise action ever requires a GitHub token (or already does). Suggest making the GitHub token an input (defaulting to ${{ github.token }} or empty), and only pass the fake token from the PR validation job if you want that specific safeguard there.

It's made on purpose since we don't want Lokalise to push anything by mistake.

Copilot · 2026-03-31T07:59:27Z

.github/workflows/pr.yml

+      - uses: ./.github/actions/download-translations
+        if: steps.changes.outputs.skip != 'true'
+        name: Download Translations
+        with:
+          lokalise-project: ${{ secrets.LOKALISE_PROJECT }}
+          lokalise-token: ${{ secrets.LOKALISE_TOKEN }}
+


Download Translations in this PR workflow uses repository secrets (LOKALISE_PROJECT/LOKALISE_TOKEN). On pull requests from forks, these secrets are not provided, so any PR that changes .github/actions/download-translations/ will cause this job to fail even if the changes are correct. Consider adding an additional guard (e.g., only run when github.event.pull_request.head.repo.full_name == github.repository or when the secrets are non-empty) and document how maintainers should validate forked PRs.

It's fine that it fails on forks it's on purpose too, only Renovate that runs within this repository is going to trigger this workflow.

.github/workflows/pr.yml

Co-authored-by: Joris Pelgröm <jpelgrom@users.noreply.github.com>

TimoPtr · 2026-04-01T12:33:54Z

.github/actions/download-translations/action.yml

-
-        echo "Download Ready: $ZIP"
-
-        curl "$ZIP" --output strings.zip


I removed this line while going over the script this should be brought back.

Use localize Github action to download translation

58fa939

Copilot AI review requested due to automatic review settings March 30, 2026 16:34

home-assistant bot added the cla-signed label Mar 30, 2026

Copilot started reviewing on behalf of TimoPtr March 30, 2026 16:35 View session

TimoPtr requested a review from jpelgrom March 30, 2026 16:37

Copilot AI reviewed Mar 30, 2026

View reviewed changes

jpelgrom reviewed Mar 30, 2026

View reviewed changes

jpelgrom changed the title ~~Use localize action and async download~~ Use Lokalise action and async download Mar 30, 2026

Apply PR suggestions

5ef30cb

TimoPtr force-pushed the feature/use_localize_action branch from 638f406 to 5ef30cb Compare March 31, 2026 07:52

TimoPtr requested a review from jpelgrom March 31, 2026 07:54

TimoPtr requested a review from Copilot March 31, 2026 07:56

Copilot started reviewing on behalf of TimoPtr March 31, 2026 07:56 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

Apply PR comments

4ce1eac

jpelgrom reviewed Mar 31, 2026

View reviewed changes

.github/workflows/pr.yml Outdated Show resolved Hide resolved

Update .github/workflows/pr.yml

000f509

Co-authored-by: Joris Pelgröm <jpelgrom@users.noreply.github.com>

jpelgrom approved these changes Mar 31, 2026

View reviewed changes

TimoPtr merged commit 175374f into main Mar 31, 2026
12 of 22 checks passed

TimoPtr deleted the feature/use_localize_action branch March 31, 2026 14:03

TimoPtr commented Apr 1, 2026

View reviewed changes

TimoPtr mentioned this pull request Apr 1, 2026

Bring back strings.zip #6668

Merged

Uh oh!

Conversation

TimoPtr commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Any other notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

jpelgrom commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jpelgrom Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

TimoPtr Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

TimoPtr commented Mar 30, 2026

Uh oh!

jpelgrom commented Mar 30, 2026

Uh oh!

TimoPtr commented Mar 30, 2026

Uh oh!

jpelgrom commented Mar 30, 2026

Uh oh!

TimoPtr commented Mar 30, 2026

Uh oh!

jpelgrom commented Mar 30, 2026

Uh oh!

TimoPtr commented Mar 30, 2026

Uh oh!

jpelgrom commented Mar 30, 2026

Uh oh!

TimoPtr commented Mar 31, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

TimoPtr Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

TimoPtr Mar 31, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

TimoPtr Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

TimoPtr commented Mar 30, 2026 •

edited

Loading

jpelgrom commented Mar 30, 2026 •

edited

Loading