Monitor GitHub Activity in Smartling

The Smartling GitHub Activity Page is designed to provide Developers and Localization Managers with an overview of GitHub activity within your GitHub Connector project in Smartling. You can use this page to view the link between GitHub activity and your Smartling project's translation jobs. You can use this page to see pull requests and commits that initiate or do not initiate translation Jobs.

Tip: GitHub files can now be found in the Files tab of your GitHub Connector project in Smartling.

Accessing the GitHub Activity Page

To access the GitHub Activity Page in Smartling, follow these steps:

• In Smartling, go to your GitHub Connector project
• Click the GitHub Activity tab

Default View

The default view of the GitHub Activity Page is set to display all open pull requests that have translatable content in files that match with a configuration set.

Overview

On this page, you will find information on the following:

• Pull Requests
• Push Commits
• Manual Actions
• Scheduled Tasks

Direct Links to GitHub

The GitHub Activity Page provides direct links to GitHub resources:

• Pull Requests: Click the pull request name to view it in GitHub.
• Pull Request Branches: Click the branch name to access GitHub branches.
• Files: Click the file path to view files inside of commits in GitHub.
• Authors: Click the Author name to view and access the user profile in GitHub.

Pull Request Activity

The Pull Requests tab displays information about all pull requests within your GitHub repository, including the following:

• Configuration set name and UID
• Pull request name linked to GitHub
• Author name linked to their GitHub profile
• Pull Request status in GitHub
• Branch name linked to GitHub
• Created date and time
• State
• Number of commits within the pull request, linked to a pre-filtered Push Commits page

Pull Request Filters

Search and filter for specific pull requests by using any of the following filters:

• Configuration: Filter pull requests by the configuration set they belong to.
• Pull Request Name: Search for pull requests by name.
• Pull Request Number: Search for a specific pull request using the PR number.
• Branch Name: Search by the name of the GitHub branch.
• State: Filter by the state of the pull request.
• Pull Request status: Filter pull requests by their status in GitHub (e.g. Open, Draft, Closed)
• Matched Configuration: Filter pull requests that are or are not matched with a configuration set.
  
  • Use this filter to find if changes were made to a file that the connector is monitoring as part of a configuration set.

Push Commits Activity

The Push Commits tab displays information about all commits within your GitHub repository, including the following:

• Configuration set name, UID and mode
• Branch name linked to GitHub
• Author name linked to their GitHub profile
• Commit SHA, or hash, linked to the specific changes made in the commit in GitHub
  • This is particularly useful for tracking change history in GitHub
• GitHub created date and time
• The number of files within the commit, linked to the source file details
• The translation Job, linked to the Job details
• States

Push Commit Filters

Search and filter for specific Push Commits by using any of the following filters:

• Configuration: Filter Push Commits based on the configuration set they belong to.
• Configuration type: Filter for commits in Pull Request, Single Branch, or On Demand mode.
• Branch Name: Filter by the name of the GitHub branch.
• Pull Request Number: Search for a specific pull request using the PR number.
• Job Name: Search by the name of the translation job linked to Push Commits
• State: Filter by the state of the Push Commit (e.g., skipped, delivered).

Manual Actions

The Manual Actions tab shows details of the following:

• On-Demand Import/Export
  • Details of activity from On-Demand mode Configuration Sets
• Initial Jobs
  • This synchronization activity happens when a Configuration Set is enabled. It helps Smartling to catch up on any changes in GitHub while the Configuration Set was disabled.
• Manual Exports
  • Translation exports triggered by using the Export Translations button in a Configuration Set. 
  • If Early Delivery is enabled for a Configuration Set, the Final Delivery for the Initial Job will also show up as a Manual Export 
• Instrumented Source File Export
  • Similar to Manual Exports, this action generates instrumented files for context matching. Instead of exporting translations, this will generate source files that are exported to GitHub in the same location as your translation path.

Scheduled Tasks

The Scheduled Tasks tab shows the status of each task, the most recent run time, and the next scheduled run time.

Clicking on the source or translated file links for the most recent run will give you detailed results for that run. 

Using the "View History" action on the schedule shows you the full history of runs for that schedule.

The connector can't deliver any new files if GitHub already has the latest translations.
The schedule will show as Completed, but the same schedule will show an Error state on the View History page. For more information, see GitHub Connector Scheduled Tasks. 

Source file details

Further details of the source files that were modified in a commit in GitHub are linked under the Source Files Count column in the Push Commits tab. Here, you can identify:

• The file path linked to GitHub
• The file URI in Smartling, linked to the file in Smartling
  • Use this to understand string uniqueness 
• Created date and time
• The translation Job, linked to the Job details
• State, including:
  • Not Uploaded
  • Uploading
  • Uploaded
  • Error

Translated file details

When a commit has reached the Delivered, Delivered with Error and Translation Merged state, you can see a list of the translated files that have been pushed back to GitHub. 

For more information on the translation files, click the “X translation files” text under the state label, to view the following:

• File Path: The location and name of the file pushed to GitHub
• File URI: The full name and link to the source file that was uploaded to Smartling for translation
• Locale: The language and locale code the file is translated into.
• Created: The date and time when the translated file was generated and pushed to GitHub
• Translation Job: The full name and link to the job in your project
• State: Indicates whether the translated file was successfully pushed to GitHub. These include:
  • Not Delivered
  • Delivering
  • Error
  • Rate Limited
  • Delivered

States Explained

• Created: A pull request has been created. We will scan the details of this activity to determine if it matches a configuration set.
• Not Uploaded: New activity has been detected and is being analyzed against enabled Configuration Sets in the project.
• Uploading: Files are being uploaded to Smartling.
  • Short delays can occur when large numbers of files need to be uploaded.
• Uploaded: All files from detected GitHub activity have been uploaded
• Uploaded with error: Partial upload; some files could not be uploaded from GitHub to Smartling due to an error
• Error: An error was detected when transferring files from related to the GitHub activity and has been logged.
  • Click the status message to view more details about the error.
• Skipped: This GitHub activity will not be processed.
  • This is typically the status of commits that do not contain files that are part of the configuration set. 
  • Click the status message to view more details.
• In translation: Translation of files from your GitHub activity is in progress.
• Delivering: The translation of files is complete, and they are being pushed to GitHub
• Delivered with error: Translated files are delivered to GitHub, but some files had errors during the transfer.
• Delivered: All translated files have been delivered to GitHub successfully
• Translation merged: Translated files have been merged from the translation branch to the feature branch in GitHub after delivery
• Canceled: Processing of this GitHub activity has been interrupted by a user's action.
  • Click the status message to view more details.
• Rate limited: GitHub has limited the volume of requests to its APIs. When this state is set, the GitHub Connector will wait before retrying the interrupted communications.
• On hold: The pull request has been placed on hold because the configuration set has enabled the Translation Hold functionality.

Error Details

When the translation state is "Error", "Skipped", or "Canceled", you can find out more information about what happened by clicking the state.

Error

The "Error" state occurs when something went wrong with the pull request or commit within your GitHub repository. Clicking the error state opens the error details, where you can view the error response.

To troubleshoot the error, we recommended searching for the error response in GitHub's documentation. 

Skipped

The "Skipped" state is a result of changing a file in GitHub without triggering a Job. A file is typically skipped because no translatable files were found in the commit. In other words, the changed file is not matched with a configuration set.

To solve this, go to your GitHub Settings and adjust the configuration set to include the file you want to translate. This may involve adding or editing the necessary file types in the configuration, and adjusting the search file path to include all the locations you would like to monitor.

Canceled

The canceled state means that the processing of the GitHub activity has been interrupted by a user's action.  For example, it could be because a user made any one of the following actions:

1. Converted the pull request to a Draft
2. Put the pull request "On Hold"
3. Cancelled the translation Job
4. Closed the translation pull request without merging
5. Made a force-push commit with history change