Working with WordPress and GitHub Actions

In the most recent Open Source Friday, we were joined with Helen Hou-Sandi, Director of Open Source Initiatives at 10up and Core Developer at WordPress, to chat about how GitHub Actions have improved everyday needs for WordPress development.

10up / actions-wordpress

GitHub Actions for WordPress!

Here is a collection of GitHub Actions and workflows to help with common needs for WordPress development. Specific documentation for each Action is in its respective respository, and other example workflows leveraging existing Actions can be found in this repository. Ideas for future Actions can be found in issues.

More information about GitHub Actions

Ready to use

The following GitHub Actions are published, available to use, and actively supported by 10up.

Deploying a plugin to the WordPress.org repository

Whenever you tag a new version of your plugin on GitHub, your changes will be committed to both trunk and the appropriate tags subfolder in your WordPress.org plugin repository.

WordPress.org Plugin Build Zip Archive

This Action will build a zip archive of your WordPress plugin and attach that archive as an artifact, allowing you to download and test prior to deploying any changes to WordPress.org. This gives…

View on GitHub

Deploying a plugin to the WordPress.org repository

Whenever you tag a new version of your plugin on GitHub, your changes will be committed to both trunk and the appropriate tags subfolder in your WordPress.org plugin repository.

Deploying plugin asset/readme updates to the WordPress.org repository

If you push to your specified branch and it only contains changes to the WordPress.org assets directory (defaults to /.wordpress-org) or readme.txt, deploy those changes to the WordPress.org plugin repository. This is useful for being able to update things like screenshots or the Tested up to version in between tagged releases.

Publishing generated hook documentation to GitHub Pages

If you follow the JSDoc standard for your custom WordPress actions and filters, you can use this workflow to generate documentation for your theme/plugin and publish them to GitHub Pages. For an example of the output, see the Distributor hook docs.

Demo

Watch @helen show the workflows on YouTube.

Open Source Fridays

Come along to our Open Source Friday live streams. We go live on the GitHub Twitch Channel most Fridays. Join the Meetup Group to stay up to date and see the topics each week.