Skip to main content

GitHub Connector Overview

How the GitHub Connector turns changes in your repositories into wxrks translation projects, and how authentication and delivery work.

The GitHub Connector lets wxrks watch a set of files in one or more GitHub repositories and turn a change to any of them into a new translation project, already configured with the languages, workflow, and Organizational Unit you choose.

It's built for teams that keep source strings in GitHub — localization files such as JSON, YAML, XLIFF, XML, or Apple .strings/.xcstrings catalogs — and want translated files delivered back the same way, as a pull request against a branch you specify.

💡 Who is this for? This guide is for Account Admins and Project Managers who manage connector integrations for an Organizational Unit. Creating a GitHub Configuration requires a connector-management permission — if you don't see the option described below, ask your Account Admin.

How it works

The GitHub Connector is triggered manually from the wxrks interface — it does not poll GitHub on a schedule in the background. When you (or whoever manages the integration) click Create Project (Sync) for a configured repository, wxrks:

  1. Downloads a small YAML configuration file from your repository that lists which source files to translate, from which language, and into which target languages.

  2. Compares each listed file's content hash against what wxrks already has on record for it, so files that haven't changed since the last sync are skipped.

  3. Creates a new wxrks project containing only the files that changed, ready for translation.

Because the sync happens on demand rather than automatically, you decide when a GitHub update should turn into a translation project — for example, after merging a release branch, or on whatever cadence fits your release process.

Connecting to GitHub

wxrks authenticates to GitHub with a GitHub username and Personal Access Token (PAT) that you generate and paste into the connector configuration — there's no "sign in with GitHub" authorization step. The token is encrypted at rest and used only by the connector to read your repository and open pull requests; wxrks staff cannot read the raw token back out.

We recommend creating a dedicated service account (or a PAT scoped narrowly to repo access) for this integration, rather than using a personal GitHub account, so access can be rotated or revoked independently of any one person.

Delivering translations

When a project created from GitHub is completed, the connector opens a new branch off the repository's base branch, commits the translated files to it, and opens a pull request back to the base branch, so a reviewer can merge it like any other code change. Re-running a sync for the same project reuses that same branch and pull request instead of creating a duplicate.

GitHub connector page, Config tab, with Add Configuration highlighted

You'll find the GitHub Connector under Integrations in the top navigation.

Setting it up

This article covers the concept. For the full step-by-step walkthrough — creating a configuration, adding a repository, writing the config file, and running your first sync — see Setting Up the GitHub Connector.

Did this answer your question?