The Smartling GitHub Connector monitors the configured branch for new content based on the mode selected: pull requests, commits, or manual request only. This article explains each of the configuration modes and how they work.
Pull Request Mode - monitors pull requests and draft pull requests, and uploads resource files if changes have been made
Single Branch Mode - monitors commits and uploads resource files if changes have been made
On Demand Mode - content is sent for translation and delivered back manually
Important: Content branch names must not begin with "Smartling" as the connector interprets branches starting with "smartling-" as self-created ones with translations and will not monitor changes in them.
GitHub Connector modes
Each configuration set in the GitHub Connector uses one of three modes. This table compares them.
Mode | What the connector monitors | How translations are delivered | Does the original pull request wait for translations? |
Pull Request | Pull requests and draft pull requests on the watched branch | A translation pull request is raised against the feature branch once the job is complete. With Early Delivery, an early delivery pull request is raised first. | Yes. The "Smartling Translation" status check keeps the original pull request locked until the translation pull request is merged. |
Single Branch | Commits to the watched branch | A separate Smartling Translation branch is created from the initial commit, and a pull request is raised to the watched branch. | No. You can merge the source language and keep working while translation is in progress. |
On Demand | Nothing. You choose when to send content and when to export translations. | You export translations manually to a branch named | No. There is no automation. |
Pull Request Mode
Pull Request Mode watches a selected branch in your repository for all pull requests and draft pull requests containing translatable files. You can customize the configuration set not to watch draft PRs.
Once translatable files are found, the GitHub Connector creates a "Smartling Translation" status check on that pull request, posts a translation status comment, and automatically sends those files to Smartling for translation. Pull Requests with the "Smartling Translation" status should not be merged or deleted until the translations have been successfully delivered.
Status checks
In Pull Request mode, the "Smartling Translation" status check stays pending until the translation pull request is merged. Until then it shows the same description, "Waiting for status to be reported, see comment for details", whether the job is awaiting authorization, in progress, or complete with the translation pull request still open.
The status check does not show the status of the associated Smartling job, so open the translation status comment to see the relevant translation job. Click the ... menu next to the status check and select View details to jump to the status comment.
Once the translation pull request is merged, the status check turns green and changes to "All translations delivered, see comment for details", and the original pull request can be merged.
If a translation job is cancelled, the status check also passes with "All translations delivered, see comment for details" so the pull request is not blocked, even though nothing is delivered for that job. Check the translation status comment to see whether a job was cancelled.
You can configure the status check in GitHub so that the pull request remains locked until translations are done (under "Branch protection rule" > "Require status checks to pass before merging").
Alternatively, you can enable Translation Hold on the configuration set to pull request mode. This setting automatically applies a "hold" label to your GitHub pull requests. This instructs the connector to put a hold on the creation of Smartling translation jobs until the label is manually removed in GitHub. When a pull request is ready to be translated, removing the label manually in GitHub will trigger the creation of translation jobs.
Translation status comment
In Pull Request mode, the Smartling GitHub Connector posts one translation status comment on each pull request that has translatable content. The comment shows translation status without leaving GitHub, so you don't need to open the Smartling Dashboard to check on a job. The connector creates the comment when the pull request first has translatable content, then updates the same comment as status changes. It does not add a new comment for each update.
The translation status comment is on for all Pull Request mode configuration sets. There is nothing to configure. Single Branch and On Demand modes do not post a comment.
Below is an example comment: the translation job in Smartling is awaiting authorization and translations have not been delivered yet.
What the translation status comment shows
Header: "Smartling Translation Status" and the number of translation jobs created from the pull request.
Configuration set: the name of the configuration set, linked, followed by its UID.
Job table: one row for each commit that triggered a translation job.
Footer: a reminder about the order in which to merge translation pull requests, plus the time of the last update.
Column | What it shows |
Commit | The commit that triggered the translation job, linked to GitHub. |
Translation Job | The name of the job, linked to the job in the Smartling Dashboard. |
Status | The status of the job. See Job statuses. |
Translation Delivery | Shows "Pending" until the translations are delivered. After delivery, shows a link to the translation pull request and its state: "Open" (not yet merged into the feature branch), "Merged" (merged into the feature branch), or "Closed" (closed without merging). If the job is cancelled, shows a dash. |
If Early Delivery is enabled for the configuration set, the job table has separate Early Delivery and Final Delivery columns instead of the single Translation Delivery column.
Before the early delivery pull request is created, Early Delivery shows a dash and Final Delivery shows "Pending". After that, the Early Delivery column links to the early delivery pull request and shows its state (for example, "Open" or "Merged").
The Final Delivery column shows "Pending" until the final translation pull request is created, then links to it and shows its state.
Below is an example of a comment when Early Delivery is on and the job is in progress. The Early Delivery column links to the early delivery pull request, which is Open. Final Delivery shows Pending because the job isn’t complete yet.
Job statuses
In the translation status comment, each job status appears with an icon and a text label.
Status | What it means |
Awaiting Authorization | The job was created but has not been authorized yet. Translation starts after the job is authorized. |
In Progress | The job is authorized and translation is under way. |
Complete | Translation is finished for all target languages. The Translation Delivery column links to the translation pull request. |
Cancelled | The job was cancelled, either by a user or automatically because there was no content to translate. Smartling adds the cancellation date and time (UTC) to the end of the job name, for example "(Cancelled 2026/11/11 14:49:18)". |
Closed | The job was closed in Smartling after it was completed. Only completed jobs can be closed. Closing a job updates the translation status comment only. The status check does not change, and the translation pull request link stays in the Translation Delivery column. |
Below is an example of a job with the status Complete. The Translation Delivery column links to the translation pull request, which is still Open.
Below is an example of the same job after the translation pull request is merged. Translation Delivery shows the pull request as Merged.
Below is an example of a cancelled job. The job name ends with the cancellation date and time, and Translation Delivery shows a dash.
Below is an example of a closed job. The Status column shows Closed, and the translation pull request link stays in Translation Delivery.
Multiple configuration sets
If a pull request changes files that belong to more than one configuration set, for example when two configuration sets watch different paths in the same repository, the connector still posts a single translation status comment.
The comment has a separate section, with its own job table, for each configuration set. The columns in each table depend on that configuration set, so a set with Early Delivery shows Early Delivery and Final Delivery columns while another set shows Translation Delivery.
Merge order
If multiple translation pull requests are created for the same pull request, the footer of the translation status comment reminds you to merge them in chronological order to ensure complete translations on the target branch. This reminder is static text. The comment does not check or enforce the merge order.
Things to know about the translation status comment
Deleted comment: If the comment is deleted, the connector creates a new one on the next status change and updates the View details link on the status check to point to it.
GitHub errors: If GitHub rejects a comment update, translation is not affected. The connector retries on the next status change. The status check keeps updating, so merge protection still works.
Authentication: The comment works with both the OAuth App and the GitHub App connection types. No additional permissions are required.
How translations are delivered in Pull Request Mode
In Pull Request mode, once the translation job is completed for all configured languages, the connector creates a separate Smartling Translation branch from the original branch that triggered the translation job from the Pull Request.
This new branch contains the translated files, and follows the naming convention:
smartling-translation-[status]-[Job UID]-from-[original branch name that triggered the PR]
example: smartling-translation-completed-94wpkn6cgztj-from-create-original-string
Note: Ensure there are no custom security rules on your GitHub that prevent the creation of translation branches, as this will block translation delivery.
The connector then raises a Pull Request against the feature branch (the branch the original pull request was opened from), which needs to be merged into the feature branch. You can customize the configuration set to add all developers who worked on the pull request (committers) as reviewers in GitHub to the translation pull request.
Once this Pull Request is accepted and merged into the feature branch, the "Smartling Translation" check is marked as resolved, unlocking the original Pull Request. Both the source files and their corresponding translations can then be merged into the watched branch.
Tip: Watch our video explanation of Pull Request Mode here.
Single Branch Mode
With the Single Branch Mode, the connector monitors the watched branch for commits. As soon as a commit is made, Smartling creates a translation Job for the file. Upon completion of the translation Job for all languages, the translations are delivered to GitHub in a separate Smartling Translation Branch that is created from the initial commit.
To deliver the translated files, the connector raises a Pull Request to the watched branch labeled "Smartling translations are completed" or "Smartling translations are updated". If no conflicts are present, the Pull Request can be merged and the Smartling Translation Branch can be deleted.
Tip: Watch our video explanation of Single Branch Mode here.
On Demand Mode
On Demand mode gives you full control over exactly when files are sent for translation and exactly when translations are delivered back to GitHub. Similar to the other modes, when set to On Demand mode, the connector is integrated with a specific branch within your repository. However, unlike the other modes, it is not monitoring pull requests or commits on branches. It is simply connected to the branch, ready to send content to Smartling when you are.
Once translations are complete, you can manually export the translated content back to GitHub. The manual export delivers translations in a branch using this naming convention: smartling-translations-<yyyyMMddHHmmssSSS>
On Demand mode is recommended if you want full control over when content is sent to Smartling for translation.
Tip: Watch our video explanation of On Demand Mode here.
Which mode is best for you?
Depending on the needs of your organization, your development process (do you use pull requests or commits, and how often), whether you want translations delivered so they can be merged and tested at the same time as the original copy, or whether you need control, you can select one of three modes for each configuration set: Pull Request, Single Branch, or On Demand.
Different modes can even be used within the same Smartling project, as part of separate configuration sets. We recommend testing each configuration mode and discussing with your Smartling representative.
Pull Request mode requires all features to be fully translated before they are merged into the main branch, helping to ensure that no untranslated strings are released on the production version of your application. The original pull request will stay locked until all translations are merged, preventing the source branch from being deleted.
Pull Request Mode is recommended if you want to make sure all feature content is completely translated, and you can wait to merge feature pull requests until all translations are done.
Single Branch mode automates the creation of translation jobs and delivery of translated content. This mode is ideal if you need to merge the source language and continue testing your application while translations are in progress. This mode also allows you to delete the source branch as soon as the translation job has been created.
Single Branch Mode is recommended if you want development work to continue unimpeded by translation work. With this mode, you can release your product or features in the original language first, and roll out other languages later when translations are ready.
On Demand mode does not offer any automation when it comes to the creation of translation jobs or the delivery of translated files, but it allows you to control when new files are uploaded for translation and when translations are exported back to GitHub.
On Demand Mode is recommended if your content and development process require greater control over its localization.
Early Delivery of translations on Pull Request and Single Branch mode
If your development process requires any translation to move forward, you can get prepublished translations delivered early on Pull Request Mode and Single Branch Mode by enabling Early Delivery.
Prepublished translations are delivered in an early delivery pull request. In Pull Request mode, once you merge the early delivery pull request, the "Smartling Translation" status check passes and unblocks the original pull request, allowing you to merge both source and translations to the feature branch before the translation Job is complete.
In Pull Request mode, the status check stays pending until the early delivery pull request is merged. For more information, read our documentation on how to Get Translations Before Job Completion with Early Delivery.
In Pull Request mode, the translation status comment on the pull request also shows the early delivery pull request, in an Early Delivery column.












