Troubleshooting your Github integration with Guide themes

What's my plan?

Suite

Growth, Professional, Enterprise, or Enterprise Plus

Support with

Guide, any plan

This article covers error messages for the GitHub integration for Guide themes and troubleshooting steps to take when you encounter issues adding or updating a theme.

You must be a Guide admin to manage the GitHub integration.

This article covers the following topics:

• Failed to import theme
• Failed to update theme
• Make sure you have access to the repository
• Make sure the Zendesk Guide app is authorized
• Incorrect theme version number
• Theme version number is not allowed
• Cannot authorize using Internet Explorer

Failed to import theme

• Make sure you have written the GitHub repository URL or [username]/[repository] correctly. Preferably copy and paste the repository URL from the address bar when viewing the repository.

• If you are fetching from a specific branch, make sure you have written the branch name correctly.
• Make sure you have access to the repository
• Make sure the Zendesk Guide app is authorized

Failed to update theme

• Make sure you have access to the repository
• Make sure the Zendesk Guide app is authorized

Make sure you have access to the repository

Make sure you have access to the repository by going to https://github.com/settings/repositories. If you don’t see the repository it is either because your access has been revoked or the repo is deleted. Contact the administrator of the repo to find out

• If your access has been revoked you will need the repo admin to give you access again.

• If the repo has been deleted you cannot update the theme or connect it to another repo, but will have to initiate a new import from a repo that exists.

Make sure the Zendesk Guide app is authorized

Make sure the Zendesk Guide app is authorized for your account in GitHub. Go to https://github.com/settings/applications and check that the Zendesk Guide app has access to your account in the “Authorized OAuth Apps” tab.

If the Zendesk Guide app does not appear Authorized OAuth Apps, if might be because:

• The authorization for the Zendesk Guide GitHub app has been revoked and you need to re-authorize it. You can do this by trying to update your theme again or if that does not work try adding the theme as a new theme and then try and update the theme you were trying to update.

• The GitHub organization that owns the repository does not allow authorization of the Zendesk Guide app. In that case you should contact the admin of the GitHub organization to allow authorization of the Zendesk Guide app for the ‘repo’ scope. Since this is the only scope GitHub provides that gives access to the code in a repo, there is no option for allowing a smaller scope.

Incorrect theme version number

The themes version number in the manifest.json file needs to be incremented as it is conflicting with the current version number. Increment the themes version number or ask the theme developer to do so.

Theme version number is not allowed

The themes version number in the manifest.json file does not comply with the versioning convention. Have the theme developer correct the themes version number to follow the versioning convention.

Cannot authorize using Internet Explorer

You cannot authenticate using Internet Explorer because GitHub no longer supports it, however, you can authenticate using another GitHub and Zendesk supported browser, such as Google Chrome, Firefox or Safari.