English (US)
  1. Zendesk help
  2. Guide
  3. Using Guide for help center
  4. Using themes and customizing your Help Center

Updating your Github-managed theme in Guide

Jennifer Rowe
  • Edited
Zendesk Documentation Team

What's my plan?

Suite Growth, Professional, Enterprise, and Enterprise Plus专业的企业计划

Fastpath:Guide Admin > Customize design icon > Theme options menu > Update from GitHub

If you'veset up the GitHub integrationfor your Guide theme, you manage your theme in GitHub and update the theme in Guide as needed.

You must be a Guide admin to update a GitHub-managed theme in Guide.

To update your Guide theme from GitHub

  1. In GitHub, make any changes to your theme, then increment the theme version number in the manifest.json file when you are ready to update the theme in Guide.
  2. In Guide, click theCustomize designicon () in the sidebar.

    The Themes page opens.

  3. Choose the GitHub-managed theme you want to update.

    Any GitHub-managed theme has the GitHub logo beside the name of the theme.

  4. Click the options menu (), then selectUpdate from GitHub.

  5. InUpdate from GitHub, clickUpdate.

    If you want to overwrite your theme settings in the Settings panel, deselectKeep theme settings. Otherwise the import will keep the theme settings as they are set in Guide and not overwrite them from GitHub.

    Your theme updates in the Themes page.

    Return to top

    7 Comments

    • Miguel Romero

      I found this "Important:If you set up anintegration with GitHub, making any modifications to your theme in Guide will break the GitHub integration." onhttps://support.zendesk.com/hc/en-us/articles/4408838187802-Working-on-a-theme-locally

      我怎样才能重新verse the lost link with github?

      0
    • David Bjorgen

      Miguel Romero, once you've broken the link with GitHub, there is no way to restore it. Instead, you must pull another instance of your theme from GitHub and make it the live theme.

      On the occasion that I need to break the GitHub integration in order to do some live testing, here is my process:

      1. Click on the menu icon of the live theme and choose "Copy," which saves a GitHub-connected copy (complete with intact theme settings) in the theme library.
      2. Break the GitHub integration in the live theme and work on testing.
      3. Once live testing is complete, update changes in source code and push to GitHub.
      4. Back in Zendesk, go to the Theme Library and set the copy of your theme as the live theme. The disconnected copy will move to the Theme Library.
      5. Update the live theme with the latest from Github.
      6. Delete the disconnected copy in the Theme Library.
      1
    • Miguel Romero

      Thanks a lot, @David Bjorgen. I followed your process and it worked for me. I have to be very careful in the future when I edit. I appreciate your comments.

      0
    • Ahmed Zaid
      User Group Leader Community Moderator

      Hello,

      Is there a way to automate this action?

      0
    • Gorka Cardona-Lauridsen
      Zendesk Product Manager

      Ahmed Zaid

      You can automate theme updates usingGitHub actions和我们的Themes API.

      1
    • Responsable-produit

      Hello

      When i try to update my file with github I have this message :

      The version number of the imported theme is not allowed. Please contact the theme developer to verify that the version is compliant with the Semantic Versioning 2.0.0 standard and higher than the current version.

      Somebody ever had the same problem ? what can i do ?

      0
    • Sabra
      Zendesk Customer Care

      HeyResponsable-produit! That error indicate's the theme's version number in the manifest.json file does not comply with theversioning convention. This will need to be updated following convention.

      0

    Pleasesign into leave a comment.

    Related articles

    Powered by Zendesk