GT Translate Action

GitHub Action for running gtx-cli translate automation on your project. Each time you merge a PR into main, a new PR will be generate with new translations.

Usage

Navigate to Settings > Security > Secrets and Variables > Actions. Under Repository Secrets add GT_PROJECT_ID and GT_API_KEY from your dashboard.

Finally, Create a new file at .github/workflows/translate.yaml and paste the following code into it:

name: GT Translate
on:
  push:
    branches: [main]

jobs:
  translate:
    runs-on: ubuntu-latest
    if: ${{ github.event.head_commit.author.name != 'github-actions[bot]' && !contains(github.event.head_commit.message, 'gt-translate/') }}
    permissions:
      contents: write
      pull-requests: write
    steps:
      - uses: actions/checkout@v4

      - uses: generaltranslation/translate@v0
        with:
          gt_api_key: ${{ secrets.GT_API_KEY }}
          gt_project_id: ${{ secrets.GT_PROJECT_ID }}
          config: 'gt.config.json'
          pr_branch: 'gt-translate/${{ github.ref_name }}'

Inputs

Input	Description	Required	Default
gt_api_key	API key for General Translation cloud service	✅	-
gt_project_id	Project ID for the translation service	✅	-
config	Filepath to config file, by default gt.config.json	❌	-
version_id	Version ID for the translation service	❌	-
tsconfig	Path to jsconfig or tsconfig file	❌	-
dictionary	Path to dictionary file	❌	-
src	Filepath to directory containing the app source code	❌	-
default_language	Default locale (e.g., en)	❌	-
locales	Space-separated list of locales (e.g., en fr es)	❌	-
inline	Include inline tags in addition to dictionary file	❌	true
ignore_errors	Ignore errors encountered while scanning for tags	❌	false
dry_run	Dry run, does not send updates to General Translation API	❌	false
timeout	Timeout in seconds for waiting for updates to be deployed	❌	-
experimental_localize_static_urls	Run script to localize all urls in content files	❌	false
experimental_hide_default_locale	Hide the default locale from the path when localizing	❌	false
experimental_flatten_json_files	Flatten json files into a single file	❌	false
experimental_localize_static_imports	Run script to localize all imports in static file	❌	false
github_token	GitHub token for creating pull requests	❌	${{ github.token }}
version	gtx-cli version to use	❌	latest
pr_branch	Branch name for pull requests	❌	gt-translate/${{ github.ref_name }}
pr_title	Title for pull requests	❌	[ci] translation
pr_body	Body for pull requests	❌	(see action.yml)
pr_auto_merge	Enable to auto merge translation pull requests	❌	false

Development

# Install dependencies
npm install

# Build the action
npm run build

# Package for distribution
npm run package

License

FSL-1.1-ALv2