Skip to main content

​
Overview

Use the repository root action when you want a pull request check that fails on localization drift. The action runs hyperlocalise run --dry-run, streams the CLI output to the workflow log, and uploads two artifacts when enabled:
  • drift-report.json
  • drift-summary.txt

​
Example workflow

For pull request checks, check mode can fetch the GitHub pull request diff and pass it to hyperlocalise check --diff-stdin. This scopes findings and inline annotations to changed translation keys for supported .json, .jsonc, and .arb files.
When source files use extract --prefix-id keys but target files use packed ids from pack --prefix-id, set prefix-id: true so check strips source prefixes before comparing keys. This also applies to changed keys when github-diff is enabled.
External repositories can use the moving v1 ref for the latest stable v1 release. Pin an exact tag if you want stricter change control.

​
Inputs

  • check: check name. Supported values are drift and check.
  • config-path: path to the config file. Defaults to i18n.yml.
  • working-directory: working directory for the command. Defaults to ..
  • hyperlocalise-version: release version to install. Defaults to latest.
  • fail-on-drift: fail the workflow when drift is detected. Defaults to true.
  • fail-on-findings: fail the workflow when check findings are detected. Defaults to true.
  • github-diff: in check mode on pull requests, fetch the GitHub PR diff and pass it to hyperlocalise check --diff-stdin. Defaults to false.
  • prefix-id: in check mode, pass check --prefix-id so prefixed source keys are compared against packed target ids. Only supported when check is check. Defaults to false.
  • upload-artifact: upload the JSON and text artifacts. Defaults to true.

​
Drift detection

The action treats either of these conditions as drift:
  • one or more executable translation tasks in the dry-run report
  • one or more prune candidates in the dry-run report
Command failures still fail the action even if drift enforcement is disabled.

​
Artifacts

drift-summary.txt is the quick triage artifact. It records:
  • the config path used
  • the CLI exit code
  • whether drift was detected
  • affected target paths
  • affected target locales
  • affected entry keys when available
If the CLI fails before it writes JSON, the action still writes a minimal text artifact when possible.