Updating your Github-managed theme in Guide

Return to top
Have more questions? Submit a request

30 Comments

  • James Rhea

    The options menu icon image on step #4 is not visible.

    0
  • Jennifer Rowe
    Zendesk Documentation Team

    Thanks for letting us know, James! It's fixed now.

    1
  • Rachel M

    Hi Jennifer!

    I was curious if the Zendesk/Github integration can work in reverse.

    Meaning instead of "...you manage your theme in Github and update the theme in Guide as needed", I have been trying to determine how to "manage our theme in Guide, and update GitHub with the changes" – as a way to keep a versioned backup of our theme code in Github.

    Thanks!

    0
  • Jennifer Rowe
    Zendesk Documentation Team

    Hi Rachel, 

    No, the integration doesn't work in reverse.

    If you want to manage your theme in Guide and store a backup in GitHub, you can manually export the theme from Guide, unzip the files, and add them to a new branch in your GitHub repo.

    Hope that helps!

    0
  • Phil Williams
    Community Moderator

    It feels like I'm missing something here....

    I've been looking at version control as a better way of managing our theme and GitHub was the obvious choice but the whole process seems particularly unwieldy to me. Unless I'm missing something, for every change I make, even if it's the most minor thing I have to:

    1. Make the changes in GitHub
    2. Commit those changes
    3. Update the manifest.json file to change the version
    4. Go back to the Guide admin
    5. Select to update the theme from GitHub
    6. Wait 10-15 seconds for it to update
    7. Preview my changes
    8. Rinse and repeat...

    My other option if I sacrifice versioning is to:

    1. Create a copy of the theme (assuming major changes)
    2. Make the changes through Guide admin
    3. Save and preview instantly
    4. Make copy live

    Or am I missing something?

    0
  • Augusto Silva
    Zendesk team member

    Hey Phil Williams,

    The Github integration works best when you are using our local tools to preview.

    This way you will only pull the update when you are ready to set the theme live.

    Have a look at this article

    Hope this helps :)

    1
  • Phil Williams
    Community Moderator

    And that's what I'm missing! :D

    Thanks Augusto, that looks perfect!

    1
  • Phil Williams
    Community Moderator

    OK made some progress. I've installed the ZAT server successfully, created an API token as we use Google to sign in and opened chrome with:

    https://<<oursupportdomain>>.zendesk.com/hc/admin/local_preview/start

     

    Now if I open this in Chrome I get bounced straight to the help centre preview. Thinking this was because I was logged in (which I was) I switched to Firefox instead and just got directed towards our Zendesk login page.

    Going to http://localhost:4567/hc/admin/local_preview/start I just got "Sinatra doesn't know this ditty" so somethings not working here?

     

    0
  • Augusto Silva
    Zendesk team member

    Now if I open this in Chrome I get bounced straight to the help centre preview.

     

    The preview you are seeing now should be with templates coming from your local machine. Try to change a template and see if the page changes. :)

    0
  • Phil Williams
    Community Moderator

    OK I figured out that I needed to hit the URL again after logging in however the content is still mixed due to the http/https mix. I've tried allowing our boundary domain in Chrome to allow insecure content but no change.

    In firefox I've also allowed it but it just hangs for an age and simply never loads the local preview.

    0
  • Phil Williams
    Community Moderator

    If it makes a difference I don't see the shield icon in chrome which warns about mixed content. I've added our support domain to the whitelist and still no joy. Very strange...

     

    0
  • Phil Williams
    Community Moderator

    Yep it's definitely still being blocked:

    0
  • Phil Williams
    Community Moderator

    Why is it trying to fetch content from localhost:4567/guide/? I navigated directly to the folder containing the theme export and the style.css and jscript.css files are in the root. There is no folder named guide...

    0
  • Phil Williams
    Community Moderator

    Sorted. After allowing the insecure content through Chrome I had to stop and then restart sinatra.

     

    There's an hour I'll never see again but hopefully will help someone!

    0
  • Brett Bowser
    Zendesk Community Team

    Thanks for taking the time to share this with everyone Phil!

    0
  • David Bjorgen

    It would be nice if version number in the manifest.js file appeared somewhere on the theme card on the Themes page. The only way to see if your version matches the version in Github is to attempt to update it.

    1
  • Phil Williams
    Community Moderator

    Agree with that...

    0
  • Devan - Community Manager
    Zendesk Community Team

    Hello Phil Williams & David Bjorgen,

    Understandable why you would want that. I'd recommend posting this feedback on our Community Feedback Forums so our devs can consider that update for our future roadmaps. 

    Best regards. 

    0
  • Lev

    Hi, 

     

    i have this problem when i am trying to update the theme from git

     
     
    0
  • Phil Williams
    Community Moderator

    You need to update the version number in the file manifest.json. It's right at the top:

    "name": "Boundary-Github",
    "author": "Boundary",
    "version": "5.2.3",
    "api_version": 1,
    "settings": [

    Do that and then try the import again.

    What I tend to do is make that change as soon as I create a new branch as it's caught me out plenty of times!

    1
  • AJ 7885

    Is there any integration service like Github available for Bitbucket too?

    0
  • Brett Bowser
    Zendesk Community Team

    Hey AJ,

    It looks like there's a 3rd party integration owned by Zapier here: https://zapier.com/apps/bitbucket/integrations/zendesk

    You may want to contact their team to get more information.

    I hope this helps!

    0
  • Matthew Bass

    Is there a way to deploy theme changes from GitHub to Zendesk without having to visit Zendesk's UI to click the "Update from GitHub" link? I'd like to automate the process so any time a change is checked into our GitHub repository, it automatically gets updated in Zendesk as well.

    0
  • Augusto Silva
    Zendesk team member

    Hi Matthew Bass,

    No, currently the Github integration only supports manual updates.

    For continuous integration use cases, we would suggest using Github Actions with our public API instead. You can find the api docs in https://developer.zendesk.com/rest_api/docs/help_center/theming

    You can find an example of using github actions with the themes api in the Copenhagen theme repo: https://github.com/zendesk/copenhagen_theme/blob/master/.github/workflows/lighthouse.yml#L17-L22

    Hope this helps

    0
  • Lev

    hi, we have a critical problem that 

    how to connect theme with private git project?

    0
  • Brett Bowser
    Zendesk Community Team

    Hey Lev,

    Can you provide us with additional information on what sort of problems you're running into with updating/connecting your Github theme?

    0
  • Lev

    Hi Brett Bowser

    thanks for the super speedy reply,

    so we have be using git to control out theme version, but i am not able to connect with private git repo, because, in general, access private git repo must have git account login info, but there is seems no way to add git account info on theme. Am i explaining it clear for you? :)

    0
  • Brett Bowser
    Zendesk Community Team

    Hey Lev,

    Thanks for the additional information!

    Our integration is only for Github, not other Git services or private Git servers unfortunately.

    In this case the you would need to set up a custom integration using our API.

    Let us know if you have any other questions!

    1
  • Lev

    Hi Brett Bowser

     

    we indeed use GitHub for themes, could you tell me which API are you referring here? For the connection to private git repo 

     

    thanks 

    0
  • Augusto Silva
    Zendesk team member

    Hi Lev,

    If you are using github please follow this guide to import your private repo. You will be asked to authorize Zendesk to access your github repo.

    Once that's done you can start using the steps detailed in this article to update your theme (pull the changes from github to zendesk) every time you have a new version of the theme.

    0

Please sign in to leave a comment.

Powered by Zendesk