Skip to content

Latest commit

 

History

History
115 lines (82 loc) · 7.09 KB

README.md

File metadata and controls

115 lines (82 loc) · 7.09 KB
Raw

Crowdin Request Action Tweet GitHub Repo stars

A GitHub Action to send arbitrary requests to Crowdin's REST API

Usage

Set up a workflow in .github/workflows/crowdin-request.yml (or add a job to your existing workflows).

Read the Configuring a workflow article for more details on how to create and set up custom workflows.

name: Crowdin Request Action

on:
  # When you push to the `main` branch
  push:
    branches: [ main ]
  # And optionally, once every 12 hours
  schedule:
    - cron: '0 */12 * * *' # https://crontab.guru/#0_*/12_*_*_*
  # To manually run this workflow
  workflow_dispatch:

jobs:
  crowdin-request:

    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v4

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

Inputs

Option Required Type Description
route true string HTTP Verb + path
body false string Request body (for POST, PUT, PATCH methods)
query false string Query parameters (for GET methods)
headers false string Request headers
Retry configuration
retries false number Retries count to be made after receiving an error response
wait_interval false number Wait interval between retries. Default is 1000 ms (1 sec)
skip_error_codes false string Error codes for which the retries shouldn't be applied. Separated by comma
retry_until_finished false boolean Retry the request until the asynchronous action finished (should be used to check the status of the operation, for example, check the translation build status)

See the EXAMPLES.md file to check these parameters' usage.

Outputs

This actions provides the following outputs that can be used by other steps in your workflow:

Option Description
status Response status code
headers Response headers as JSON string with lower cased header names
data Response body as a JSON string

To access deep values of these outputs, check out the fromJson function.

Also, there are a few examples of the outputs' usage in the EXAMPLES.md file.

Environment variables

Variable Required Description
CROWDIN_PERSONAL_TOKEN true Your Crowdin Personal Access Token. Can be generated in your Account settings
CROWDIN_ORGANIZATION false Your Crowdin Enterprise organization name (for example, test-org for https://test-org.crowdin.com)

Debugging

To see additional debug logs, read the Enabling debug logging.

Contributing

If you would like to contribute please read the Contributing guidelines.

Author

License

The Crowdin Request Action is licensed under the MIT License.
See the LICENSE file distributed with this work for additional
information regarding copyright ownership.

Except as contained in the LICENSE file, the name(s) of the above copyright
holders shall not be used in advertising or otherwise to promote the sale,
use or other dealings in this Software without prior written authorization.