Skip to content

How to Deploy Your Ghost Theme Using Github Actions

Ahmad Ajmi Photo
Ahmad Ajmi

Last week I tried the Deploy Ghost Theme Github action. Wow, this is an excellent tool for theme deployment and a time saver. This tool helps with theme deployment. This means that instead of uploading your theme to your Ghost blog every time you make a change. You can now deploy your theme every time you push a new update to your theme repository master branch. So, the purpose of the GitHub action is to take the theme from the GitHub repo and send it to your website.

I assume you are familiar with using Git and GitHub, and your theme is already on GitHub.

Create a Custom Ghost Integration

The first step we need is to create a new Custom Integration in Ghost Admin » Integrations.

You can give the new integration a new name. For example, Deploy Ghost Theme.

Once created the integration, two values will be available, Admin API Key, and API URL.

Custom Ghost Integration

Create GitHub Repository Secrets

On the GitHub theme repository, navigate to Settings > Secrets.

Create two new secrets. The first one is called GHOST_ADMIN_API_KEY containing the Admin API Key. The second one is called GHOST_ADMIN_API_URL containing the API URL.

GitHub Repository Secrets

Add the Github Deployment Config File

Inside your local theme repository, create a config file called .github/workflows/deploy-theme.yml and copy the following code into it. Once you added this file, commit and push your changes to the remote repository.

name: Theme Deploy
      - master
      - main
    runs-on: ubuntu-18.04
      - uses: actions/checkout@v2
      - uses: TryGhost/action-deploy-theme@v1.4.1
          api-url: ${{ secrets.GHOST_ADMIN_API_URL }}
          api-key: ${{ secrets.GHOST_ADMIN_API_KEY }}

You are now ready to test and do your first theme deployment. Every time you push a new commit to the repository master branch, the theme will be deployed automatically.

On the GitHub theme repository, navigate to Settings > Actions to check the theme deployment actions list.

GitHub Repository Deployment Actions

You can click any action and see more details about it.

GitHub Repository Deployment Action

I hope you find this tutorial helpful.

Subscribe to Aspire Themes

You will receive Ghost resources, new themes, and updates.

Write more
Save time & money

Ghost CMS themes for a professional-looking website. Newsletter & membership full support.

Choose your theme »
  • Ghost 4 Support
  • Free Support & Updates
  • 100% Money Back Guarantee