Missing documentation about how to pull translation later once translated and more

[dprevost-LMI]

Thanks for your GitHub action plugin and the good documentation that helped us kickstart.

I noted a few missing crucial information so that we could make a complete working solution:

1. What are the basic permissions for uploading and downloading translations in the Crodwin project token? I understand it is specific for each integration, but a basic example of a simple integration should be provided to help us. This post end-up helping me

2. Once we have a working example and the PR gets created, we need to wait for a human to translate the token and pull those later. There are no mentions of possible strategies to tackle that. This is essential documentation to provide. On my part, I use the scheduling approach of Github action Con trask to pull a couple of times per day. I added the below to the on keyword:

on:
...
  schedule:
    # Running at 8 AM, 12 PM, 5 PM, and midnight.
    - cron: '0 8,12,17,0 * * *'

3. I had to do some twists to correctly create the proper PR from the base branch and all. Below is what I used. That is another helpful thing that would be nice to document

      - name: Checkout PR branch
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.ref }}
          repository: ${{ github.event.pull_request.head.repo.full_name }}

[andrii-bodnar]

Hi @dprevost-LMI, thanks for your suggestions!

1 - will be addressed in #260.

2 - It is described in the Triggers section of usage examples.

3 - Looks like the Checking out multiple branches in a single workflow case.

[andrii-bodnar]

There is a crowdin download translations --all parameter, but I'm not sure it's the right solution in this case due to a lack of context.

https://crowdin.github.io/crowdin-cli/commands/crowdin-download-translations

[dprevost-LMI]

Cool for point 1. For 2 and 3, I'm surprised I did not look at the example file; usually, I do it in open-source repos, but not that time 😄 . A suggestion could be to state it more directly in the central MD. Something like:

To pull the translated token once processed by translators, you have a few options; see possible triggers

Lastly, The below doc in the readme points to a 404 of Git Hub!

Read the Configuring a workflow article for more details on creating and setting up GitHub workflows.

[andrii-bodnar]

Thanks, it definitely makes sense to add more descriptions to the examples document.

Lastly, The below doc in the readme points to a 404 of Git Hub!

Something has changed on their side, I will take a look.