Explain dry run mode

[koppor]

Is your feature request related to a problem? Please describe.

I changed translations on Crowin. I use the dry run mode. I do not see any changes:

Question: Did I use the wrong files? Did I not update properly? Or does the "dry run" mode not make any commit?

Describe the solution you'd like

A clear and concise description of what dry run mode does.

Describe alternatives you've considered

Experiement around with the action in non-dry mode.

[andrii-bodnar]

Hi @koppor, this is the expected behavior in dry-run mode. When you use the --dryrun flag with the Crowdin CLI (which is used under the hood of GH Action), it simulates the output of the command as if it were actually executed, but it doesn't make any real changes to your Crowdin project or your local filesystem.

[koppor]

"No changes" could be interpreted as: Try to do all read-commands.

For instance, I get

UPLOAD TRANSLATIONS
✔️  Fetching project info
❌ Failed to upload translations for the source 'jablib/src/main/resources/l10n/JabRef_en.properties' since file 'JabRef_en.properties' is missing in the project. Run the 'crowdin push' to upload the missing source
❌ Current execution finished with errors

The check " file 'JabRef_en.properties' is missing in the project" can be done without any write operations.

OK, that would maybe require some backend changes, which are not desired?

[andrii-bodnar]

"No changes" could be interpreted as: Try to do all read-commands.

Yes, it is.

@koppor, could you please provide your complete workflow and crowdin.yml configuration file? Also, please make sure that the action really performs the write operation in dryrun mode by checking the Crowdin project API logs in the Tools tab. We try to keep the command output the same in both modes (regular and dryrun), so it doesn't mean that the write action is actually performed.

[koppor]

(Note: Crowin is working on my side now; I switched to life mode, fixed issues and then it went well)

The last commit in dry-run mode: https://github.com/JabRef/jabref/tree/5d961cb5ae2468a30fd182ac781db3d98ca06b57

crowdin.yml

files:
  - source: /jablib/src/main/resources/l10n/JabRef_en.properties
    translation: /jablib/src/main/resources/l10n/JabRef_%two_letters_code%.properties
    languages_mapping:
      two_letters_code:
        pt-BR: pt_BR
        zh-CN: zh_CN
        zh-TW: zh_TW

Action:

name: Crowdin Action

on:
  push:
    branches:
      - use-crowdin-action
  schedule:
     # run on each Wednesday
     - cron: '2 3 * * 3'
  workflow_dispatch:

jobs:
  synchronize-with-crowdin:
    if: github.repository == 'JabRef/jabref'
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: crowdin action
        uses: crowdin/github-action@v2
        with:
          upload_sources: false
          upload_translations: true
          upload_language: de
          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](https://github.com/crowdin/github-action)'
          pull_request_base_branch_name: 'main'
          dryrun_action: true
        env:
          GITHUB_TOKEN: ${{ secrets.GH_TOKEN_JABREF_MACHINE_PR_APPROVE }}

          # A numeric ID, found at https://crowdin.com/project/<projectName>/tools/api
          CROWDIN_PROJECT_ID: 294858

          # Visit https://crowdin.com/settings#api-key to create this token
          CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}

[andrii-bodnar]

@koppor thank you for the details provided!

I don't see any problems with the configuration and workflow. Could you please clarify what the issue is with the dryrun mode? Thank you very much!

[koppor]

I switched to Crowdins integration. I will come back if I can provide more details.