Configuration Options
Every input and output of Shipi18n/shipi18n-github-action@v3. The default mode is check, which needs no key.
Check mode (default)
| Input | Default | Description |
|---|
mode | check | check validates locale files; translate translates with your own key |
locales | ./locales | Locale root: flat, nested, Rails, ARB, .xcstrings, Android, gettext or XLIFF |
source-language | en | Source language the translations are compared against |
severity | — | Per-rule levels, e.g. missing-key=off,untranslated=off,orphan-key=off to report only runtime breakage (error, warning, info, off) |
baseline | — | Baseline JSON from npx @shipi18n/cli check --write-baseline: existing findings stop failing the job, new ones still do |
fail-on | error | Fail the job on error, warning or none |
min-coverage | — | Fail any language below this coverage percentage |
ignore-keys | — | Comma-separated * globs of keys to silence (path or ns:path) |
glossary | — | Glossary JSON: do-not-translate and locked terms, checked deterministically |
sarif-file | shipi18n.sarif | Where the SARIF report is written; upload it for PR annotations |
Translate mode (mode: translate, your own key)
| Input | Default | Description |
|---|
provider | anthropic | anthropic or openai |
api-key | — | Your LLM key; falls back to ANTHROPIC_API_KEY / OPENAI_API_KEY. Store it as a secret |
model | — | Override the provider's default model |
source-file | — | Source locale file, e.g. locales/en.json (this or source-dir) |
source-dir | — | Source locale directory; every JSON file in it is translated |
target-languages | — | Required in translate mode: comma-separated codes, e.g. es,fr,de |
output-dir | — | Where translated files go (default: next to the source) |
incremental | true | Only translate keys that changed since the previous commit |
create-pr | false | Open a pull request instead of committing directly |
branch-name | shipi18n-translations | Branch for the PR |
commit-message | chore: update translations [skip ci] | Commit message |
github-token | GITHUB_TOKEN | Token used to push and open PRs |
skip-keys | — | Exact dot-paths to leave untranslated, e.g. brandName,company.name |
skip-paths | — | Glob patterns to skip, e.g. states.*,config.*.secret |
Outputs
| Output | Mode | Description |
|---|
errors | check | Number of errors found |
warnings | check | Number of warnings found |
sarif-file | check | Path of the SARIF report |
files-changed | translate | Number of translation files updated |
files-list | translate | JSON array of translated files |
languages | translate | Languages translated |
verification-errors | translate | Placeholder and key errors found after translating |
verification-warnings | translate | Unusual length ratios found after translating |
skipped-keys-count | translate | Keys skipped via skip-keys / skip-paths |
%20--%3e%3csvg%20version='1.1'%20id='Layer_1'%20xmlns='http://www.w3.org/2000/svg'%20xmlns:xlink='http://www.w3.org/1999/xlink'%20x='0px'%20y='0px'%20viewBox='0%200%20720%20720'%20style='enable-background:new%200%200%20720%20720;'%20xml:space='preserve'%3e%3cstyle%20type='text/css'%3e%20.st0{fill:%232664EB;}%20%3c/style%3e%3cpath%20class='st0'%20d='M652.1,507.8c14.1-33.4,22.3-68.7,24.4-104.9c0.3-1.4,0.5-2.9,0.5-4.5c0-0.9-0.1-1.9-0.2-2.8%20c0.1-3.7,0.2-7.5,0.2-11.3V143c0-0.3,0-0.7,0-1c0-0.1,0-0.1,0-0.2c0-0.3,0-0.6-0.1-0.8c0-0.1,0-0.1,0-0.2c0-0.3-0.1-0.6-0.1-0.8%20c0-0.1,0-0.1,0-0.2c-0.1-0.3-0.1-0.6-0.2-0.9c0,0,0-0.1,0-0.1c-0.1-0.3-0.1-0.6-0.2-0.9c0,0,0,0,0-0.1c-0.1-0.3-0.2-0.6-0.3-0.9%20c0,0,0,0,0,0c-0.6-1.6-1.3-3.2-2.3-4.6c0-0.1-0.1-0.1-0.1-0.2c-0.1-0.2-0.3-0.4-0.5-0.6c-0.1-0.1-0.1-0.2-0.2-0.3%20c-0.1-0.2-0.3-0.3-0.4-0.5c-0.1-0.1-0.2-0.2-0.3-0.3c-0.1-0.2-0.3-0.3-0.4-0.4c-0.1-0.1-0.2-0.2-0.3-0.3c-0.1-0.1-0.3-0.3-0.4-0.4%20c-0.1-0.1-0.2-0.2-0.3-0.3c-0.2-0.2-0.4-0.4-0.6-0.5c0,0-0.1-0.1-0.1-0.1l0,0c0,0,0,0,0,0L543.2,23c-3.4-2.8-7.7-4.4-12.2-4.4H188.3%20c-4.5,0-8.8,1.6-12.2,4.4L49.9,128.3c0,0,0,0,0,0l-0.1,0.1c-0.1,0-0.1,0.1-0.1,0.1c-0.2,0.2-0.4,0.3-0.6,0.5%20c-0.1,0.1-0.2,0.2-0.3,0.3c-0.1,0.1-0.3,0.3-0.4,0.4c-0.1,0.1-0.2,0.2-0.3,0.3c-0.1,0.1-0.3,0.3-0.4,0.5c-0.1,0.1-0.2,0.2-0.2,0.3%20c-0.1,0.2-0.3,0.3-0.4,0.5c-0.1,0.1-0.1,0.2-0.2,0.2c-0.2,0.2-0.3,0.4-0.5,0.7c0,0-0.1,0.1-0.1,0.1c-1,1.4-1.7,2.9-2.3,4.6%20c0,0,0,0,0,0c-0.1,0.3-0.2,0.6-0.3,0.9c0,0,0,0,0,0.1c-0.1,0.3-0.2,0.6-0.2,0.9c0,0,0,0.1,0,0.1c-0.1,0.3-0.1,0.6-0.2,0.9%20c0,0,0,0.1,0,0.1c0,0.3-0.1,0.6-0.1,0.8c0,0.1,0,0.1,0,0.2c0,0.3-0.1,0.5-0.1,0.8c0,0.1,0,0.1,0,0.2c0,0.3,0,0.7,0,1v241.4%20c0,4.2,0.1,8.5,0.3,12.7c0,0.4-0.1,0.9-0.1,1.3c0,1.1,0.1,2.1,0.3,3.1c1.9,36.7,10.1,72.4,24.5,106.3c13.3,31.4,31.3,60.1,53.8,85.6%20c0.3,0.3,0.5,0.6,0.8,0.9c4.3,4.9,8.8,9.6,13.4,14.2c29.1,29.1,63,52,100.8,67.9c39.1,16.5,80.6,24.9,123.4,24.9%20c42.8,0,84.3-8.4,123.4-24.9c37.8-16,71.6-38.8,100.8-67.9c4.8-4.8,9.4-9.8,13.9-14.8c0.1-0.1,0.1-0.2,0.2-0.2%20C620.7,568,638.8,539.2,652.1,507.8z%20M518.9,538.2c4.2-9.8,8.1-19.8,11.6-30.2c10.1-29.4,17-59.8,20.8-90.6H637%20c-6.3,52.8-27.4,101.2-59,140.8C558.6,550.5,538.9,543.8,518.9,538.2z%20M298.5,318.1c0-34,27.5-61.5,61.5-61.5%20c34,0,61.5,27.5,61.5,61.5c0,34-27.5,61.5-61.5,61.5C326,379.6,298.5,352.1,298.5,318.1z%20M341,644.3c-24.3-8.9-50.7-32.7-73.7-67.4%20c-2.8-4.2-5.5-8.6-8.2-13.1c26.9-5,54.2-7.9,81.9-8.9V644.3z%20M379,645.1v-90.1c28.4,1,56.5,4.1,84,9.3c-2.6,4.3-5.2,8.6-8,12.7%20C431.3,612.7,404,636.9,379,645.1z%20M372.5,516.7c87.6-132.1,104.3-145.3,104.3-198.6c0-64.5-52.3-116.8-116.8-116.8%20s-116.8,52.3-116.8,116.8c0,53.3,16.7,66.5,104.3,198.6c-36.2,0.7-71.8,4.7-106.7,11.9c-15.4-34.3-26.2-72.5-31.4-111.1h47%20c-9.3-14.7-16.3-26.8-21.4-38.1h-154V162h557.9v217.4h-154c-5.1,11.3-12.1,23.4-21.4,38.1h49.4c-5.2,38.7-16.1,77.1-31.6,111.6%20C445.7,521.6,409.4,517.4,372.5,516.7z%20M142,558.3c-31.6-39.6-52.7-87.9-59-140.8h88c3.7,30.8,10.7,61.2,20.8,90.6%20c3.5,10.1,7.3,20,11.4,29.6C182.5,543.4,162.1,550.2,142,558.3z%20M605.2,124h-210l-8.6-67.3h137.5L605.2,124z%20M195.2,56.7h138.1%20l-8.5,67.3H114.6L195.2,56.7z%20M169.9,588.3c16.5-6.1,33.3-11.4,50.3-15.8c4.8,8.8,10,17.3,15.4,25.4c14.6,22,30.5,40.3,47.1,54.5%20C240,640.1,201.5,617.8,169.9,588.3z%20M441,651.4c16.1-14,31.6-31.9,45.9-53.4c5.3-8,10.3-16.3,15.1-24.9%20c16.3,4.3,32.4,9.4,48.2,15.3C519.4,617,482.2,638.8,441,651.4z'/%3e%3c/svg%3e)