A GitHub Action to send arbitrary requests to Crowdin's REST API
A GitHub Action to send arbitrary requests to Crowdin's REST API
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@v3
- name: Make Crowdin Request
uses: andrii-bodnar/crowdin-request-action@0.0.1
with:
route: GET /languages
env:
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
CROWDIN_ORGANIZATION: ${{ secrets.CROWDIN_ORGANIZATION }} # Only for Crowdin Enterprise
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.
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.
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 ) |
To see additional debug logs, read the Enabling debug logging.
If you would like to contribute please read the Contributing guidelines.
Crowdin is a platform that helps you manage and translate content into different languages. Integrate Crowdin with your repo, CMS, or other systems. Source content is always up to date for your translators, and translated content is returned automatically.
Learn MoreReleased on Nov 24, 2022
Updated on Jul 30, 2024
Published by Andrii Bodnar
Identifier:crowdin-request-action