Skip to content

Latest commit

 

History

History
219 lines (183 loc) · 6.74 KB

EXAMPLES.md

File metadata and controls

219 lines (183 loc) · 6.74 KB
Raw

Crowdin Request Action usage examples

Simple API calls

List languages

- uses: andrii-bodnar/[email protected]
  name: Make Crowdin Request
  with:
    route: GET /languages
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

Get specific language

- uses: andrii-bodnar/[email protected]
  name: Get language
  with:
    route: GET /languages/{languageId}
    languageId: uk
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

Using query parameters

- uses: andrii-bodnar/[email protected]
  name: List languages with limit
  with:
    route: GET /languages
    query: |
      {
        "limit": 10,
        "offset": 0
      }
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

The value of the query option should be a valid JSON object.

List project files

- uses: andrii-bodnar/[email protected]
  name: List Files with filter
  with:
    route: GET /projects/{projectId}/files
    projectId: 2
    query: |
      {
        "filter": "crowdin_sample"
      }
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

Get project progress

- uses: andrii-bodnar/[email protected]
  name: Get Project Progress
  id: project_progress
  with:
    route: GET /projects/{projectId}/languages/progress
    projectId: 2
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

- name: Access the translation progress (first language in the list)
  run: |
    echo ${{ fromJson(steps.project_progress.outputs.data).data[0].data.translationProgress }}

Please note if you want to use the action output like in this example, you need to set a unique id for the step to access its outputs.

Add string to a project file

- uses: andrii-bodnar/[email protected]
  name: Add String
  with:
    route: POST /projects/{projectId}/strings
    projectId: 2
    body: |
      {
        "fileId": 4,
        "text": "New string - ${{ github.sha }}",
        "identifier": "${{ github.sha }}",
        "context": "super context"
      }
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

The value of the body option should be a valid JSON object.

For more information about the github.sha used in this example see the github context docs.

Add storage

This example demonstrates a showcase of using headers.

There are two ways of passing the storage body:

  • specifying the file path as a body value
  • passing the file content as a body value
- uses: andrii-bodnar/[email protected]
  name: Add Storage
  with:
    route: POST /storages
    headers: |
      Crowdin-API-FileName: test-file.json
    body: __tests__/files/test-file.json
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

More complex use cases

Add a file to a Crowdin project

To add a file to a Crowdin project you need two requests: Add Storage, and Add File:

- uses: andrii-bodnar/[email protected]
  name: Add Storage
  id: add_storage
  with:
    route: POST /storages
    headers: |
      Crowdin-API-FileName: test-file.json
    body: __tests__/files/test-file.json
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

- uses: andrii-bodnar/[email protected]
  name: Add File
  if: ${{ success() }}
  with:
    route: POST /projects/{projectId}/files
    projectId: 2
    body: |
      {
        "storageId": ${{ fromJson(steps.add_storage.outputs.data).data.id }},
        "name": "test-file.json"
      }
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

In this case, we've used the add_storage step output to provide the storageId for the Add File method.

Build project translations

The translations downloading process involves making the following requests: Build project Translation, Check Project Build Status until the status will be finished, and Download Project Translations.

- uses: andrii-bodnar/[email protected]
  name: Build Project Translation
  id: build_project
  with:
    route: POST /projects/{projectId}/translations/builds
    projectId: 2
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

- uses: andrii-bodnar/[email protected]
  name: Check Project Build Status
  id: check_build_status
  with:
    route: GET /projects/{projectId}/translations/builds/{buildId}
    projectId: 2
    buildId: ${{ fromJson(steps.build_project.outputs.data).data.id }}
    retry_until_finished: true # This option will retry the build progress checking until finished
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

- uses: andrii-bodnar/[email protected]
  name: Download Project Translations
  with:
    route: GET /projects/{projectId}/translations/builds/{buildId}/download
    projectId: 2
    buildId: ${{ fromJson(steps.build_project.outputs.data).data.id }}
  env:
    CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
    CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Optional

Please note, that the retry_until_finished option was used in the Check Project Build Status step. This option will retry the request until the status will be finished and only then the next step will be executed.