Should we have a Action to check translation progress?

[lixw1021]

Hey Crowdin team.
Our team used the CLI on Team City and want to transfer to Github actions, we used to have a python script to check if the translation status is 100% before downloading the translation. This will block the PR merge if the translation is not complete. Do you think we can have an Action to check the progress?

[DimaYashchyshyn-zz]

Hi, well, I guess yes, but why wouldn't you try a native connector? It supports patterns like "export only 100% translated file" and/or "export only 100% approved file" out of the box

[lixw1021]

Thanks @DimaYashchyshyn ,
I am still trying to upload the source and haven't test download,
Do you mean to use export_only_approved: true and the download action will fail if there are translations not finished.

[DimaYashchyshyn-zz]

Well, almost, it would export only approved stings and would skip untranslated and translated. Often it's used in combination with "skip untranslated files", so as a result you receive 100% approved files only

[zvictor]

In my case I am interested in not letting a new deployment happen unless the translations are done.
I rather keep my services outdated than let them have incomplete translations.

Is it possible to have the action exiting with error with any translation is missing?

[DimaYashchyshyn]

Have you tried a setup "export only approved = true"?
https://github.com/marketplace/actions/crowdin-action#supported-options
this will export only fully reviewed suggestions, the approved ones

[andrii-bodnar]

@zvictor please check this answer - #107 (comment)

[andrii-bodnar]

You can use an additional step with Crowdin CLI for that:

name: Crowdin sync
on:
  workflow_dispatch:

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

      - name: Install Crowdin CLI
        run: npm i -g @crowdin/cli

      - name: Check progress
        run: crowdin status translation --fail-if-incomplete 

      # other steps

the Check progress step will fail if the Crowdin project is not fully translated.

The same is relevant for a single language: crowdin status translation --fail-if-incomplete -l uk

[zvictor]

Beautiful!
I must say that the support and commitment of this community is outstanding! Thank you so much ❤️

[anshu7vyas]

@andrii-bodnar thanks for a quick response, I am using this command you mentioned for specific branches like so:

crowdin status translation --fail-if-incomplete --branch ${{ steps.clean_branch_name.outputs.cleanBranchNameForCrowdIn }}

Now the issue I am facing here is if the upload_translations job detects that some translation strings were removed, it would delete the branch as well from CrowdIn, and this translation progress command would fail (as expected) since the branch now does not exist on CrowdIn.

May I ask if there's a way we can check if the branch exists on CrowdIn before running this command, so that we can pass this job if the branch doesn't exist? I went through the CrowdIn CLI documentation but couldn't find a command to check for an existing branch in crowdin.

[andrii-bodnar]

@anshu7vyas you can use the crowdin list branches command. In addition, I'd recommend using the --plain option that will provide an easily processable command output: crowdin list branches --plain

To see all the possible options, run the crowdin list branches -h command.

[anshu7vyas]

Thanks @andrii-bodnar, this was helpful!