How to setup Github with Staq (plugin/theme only)

Introduction

Please note – this KB is to integrate Github when a plugin or theme is in its own repository. If you have an entire site in its own repository, please see this KB on how to integrate your entire site’s repo into Staq instead. To integrate a plugin/theme in its own repo from Github, please see the information below on how to setup inside Staq.

Global / Website managed plugins/theme

Global managed plugin/theme

You can manage your Github repository as a WordPress plugin inside the Staq Global Plugins section which means you can pull your changes directly into your Global Plugin in Staq and it’ll automatically update across every single site that has this Global Plugin activated on each site.

To access this function, go to Global Plugins or Global Themes > Connect via Git:

Website managed plugin

You can apply a Github repository as a WordPress plugin inside an individual website.

To access this function, go to the website in question and then Plugins > Connect via Git:

Instructions

Select Github and enter your repository URL and then the production branch i.e. main

Click Add SSH Keys

In the next screen, click Generate SSH key:

Then, click Copy SSH key and then click link, Access keys:

Click Add deploy key:

Insert the Title, paste the Key and click Allow write access.

Click Add Key:

Go back to the Staq page and click Connect Repository:

You should be directed to a different screen and then click Add Webhook:

In the last step, click Copy secure URL and then click Webhooks:

In Github, click Add webhook:

Enter the Payload URL (this is the secure URL link inside Staq).

By default, Enable SSL verification, Just the Push Event and Active should be enabled.

Click Add webhook:

Go back to Staq and click the checkbox:

Inside the Plugins/Themes page of Staq, you should see a bucket icon that symbolizes Github connection:

If you click History, it will reveal the related events to your plugin / theme such as code pushes and system health checks realized by Staq to ensure the validity of the integration: