Configuration Options

All available options for the Shipi18n GitHub Action.

Required Inputs

Input	Description
`api-key`	Your Shipi18n API key (use secrets)
`source-dir`	Directory containing source locale files
`target-languages`	Comma-separated list of target language codes

Optional Inputs

Input	Default	Description
`source-language`	`en`	Source language code
`github-token`	-	Required for committing changes or creating PRs
`create-pr`	`false`	Create a PR instead of direct commit
`incremental`	`true`	Only translate new/changed keys
`commit-message`	`chore: update translations [skip ci]`	Commit message for translation updates
`skip-keys`	-	Keys to skip from translation (comma-separated exact paths)
`skip-paths`	-	Path patterns to skip (comma-separated, supports `*` wildcards)
`verify`	`false`	Enable LLM-based translation verification
`self-correct`	`false`	Enable self-correcting translations

Full Example

- name: Translate
  uses: Shipi18n/shipi18n-github-action@v1
  with:
    api-key: ${{ secrets.ANTHROPIC_API_KEY }}
    source-dir: src/locales/en
    target-languages: es,fr,de,ja,zh-CN
    source-language: en
    github-token: ${{ secrets.GITHUB_TOKEN }}
    create-pr: true
    incremental: true
    commit-message: "chore: update translations"

Example with Skip Keys

Keep brand names, US state codes, or config values untranslated:

- name: Translate with skip options
  uses: Shipi18n/shipi18n-github-action@v1
  with:
    api-key: ${{ secrets.ANTHROPIC_API_KEY }}
    source-dir: src/locales/en
    target-languages: es,fr,de
    skip-keys: 'brandName,company.name'
    skip-paths: 'states.*,config.*.secret'