Sync source from crowdin

[igorkova]

Is there a possibility to sync source from crowdin?

If someone changes source string in crowdin, can we have it pulled down in a PR. I guess I'm after download_sources same as we have for translations.

[andrii-bodnar]

Yes, it's possible via the download_sources option. It works in the same way as with the translations download.

You can also combine this option with the download_translations option and the Action will create a PR that includes both sources and translations from Crowdin.

[igorkova]

Thanks for a quick reply.

I tried it now and have hit a bug described here #166

[andrii-bodnar]

Could you please provide your full Crowdin GH Action configuration + crowdin.yml (without credentials) + actual/expected results? Thanks.

[igorkova]

name: Translations Sync

on:
  push:
    branches: [ main ]
  workflow_dispatch: {}

jobs:
  crowdin:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Crowdin sync
        uses: crowdin/github-action@v1
        with:
          upload_sources: true
          download_sources: true
          upload_translations: false
          download_translations: true
          localization_branch_name: l10n_crowdin_translations
          create_pull_request: true
          pull_request_title: 'New Crowdin Translations'
          pull_request_body: 'New Crowdin translations by [Crowdin GH Action]'
          pull_request_base_branch_name: 'main'

          # Sources pattern
          source: src/locales/en/messages.po
          # Translations pattern
          translation: src/locales/%two_letters_code%/messages.po

          project_id: ${{ secrets.CROWDIN_PROJECT_ID }}
          token: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

[andrii-bodnar]

please share the execution log of the Crowdin step in your WF

[igorkova]

Don’t have my laptop now but here’s small screenshot

looks like it uploads first so it overwrites changes made on crowdin.

[andrii-bodnar]

As I can see, the DOWNLOAD SOURCES step was executed successfully but there were no changes to commit for this file, only one file was changed (src/locales/sv/messages.po).

The Action just overrides the source file in Crowdin. If you want to edit source files on the Crowdin side, you should disable sources upload: upload_sources: false. Because currently, it uploads the source file (the update happens on the Crowdin side) and immediately downloads the same file.

[igorkova]

Ok. Got it.

Then maybe I have a different question.

What is the recommended way of having source file locally (owned by developers mostly) but also enabling translators that sometimes edit a source string on crowdin (maybe developer made a typo in source file [en])?

What is the recommended approach for that way of working? To have 2 [en] languages or something else?

[andrii-bodnar]

@igorkova I'd recommend enabling one of the following integrations: Jira or Issue Notification Manager. This way, translators can always report the "Mistake in the source string" issue directly from the Crowdin Editor, and your developers will receive a corresponding Jira ticket or Email.

There are a bunch of other similar integrations that are applicable to this use case - Task Management apps

Adding to the Crowdin project the same target language as a source - might also work. Developers will receive suggested translations to a source language within a PR.