THE EAP IS CLOSED
The GitHub integration for Guide themes enables Guide Managers to fetch and update custom themes directly from private or public GitHub repositories, enabling developers and Guide managers to use GitHub as the single source of truth and publish or preview the latest version of a theme at the click of a button.
How it works
How to get started depends on your whether you are starting from scratch or where your existing theme in stored.
I’m starting from scratch
If you are starting from scratch, we recommend that you fork the Copenhagen theme repo and start building your custom theme from that.
I have my theme in Guide
If you have your theme in Guide and want to start managing it from GitHub, using the developer tools you otherwise want (see " Working on a theme locally"), you’ll need to:
- Export your theme.
- Create the GitHub repo you want to host your code, if you don’t already have one.
- Push your exported theme to the desired GitHub repo.
I already have my theme in a GitHub repo
Great! In that case you all you need to do is set up the GitHub integration for your theme.
I have my theme somewhere other than Guide and GitHub
You will need to set up a GitHub repo and push your theme to the repo.
Fetching theme from GitHub
- Go to the theming workbench in Guide
- Click “Add new theme”
- Click “Fetch from GitHub”
- Input the repo URL you want to fetch your theme from and input the branch name if you want to fetch from a branch other than the default branch.
- You’ll be asked to login if you are not logged in and authorize Zendesk
- You will then be redirected to the Guide theme workbench and your newly fetched theme thumbnail will appear with a small GitHub mark to indicate that the theme is linked to a GitHub repo.
Updating your theme from GitHub
All themes that are fetched from GitHub can be updated from the same repo and branch as it was originally fetched from by clicking the cog that appears when you hover over the theme thumbnail and clicking “Update from GitHub.”
You will be asked to confirm that you want overwrite your current theme with the newest version of the branch you fetched from in your connected GitHub repo.
If you are not logged in, or if the authentication has expired, you will be asked to log in and authenticate again.
Theme ordering changes in the workbench
If you sign up for the GitHub integration you will see that the ordering of your theme thumbnails in the theme workbench has changed. We have removed the headlines “Standard themes” and “Custom themes” and are now showing all your themes by time of newest update - newest first.
Your live theme is still indicated with the green “Live” label on the thumbnail and as before there is a small icon indicating if it is a Zendesk standard theme, a custom theme or a theme connected to a GitHub repository.
This change does not affect your themes in any way, only the way your theme thumbnails are displayed in the workbench.
Post is closed for comments.