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.

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.

PHP linting without additional codebase dependencies

This action will run PHPCS (PHP_CodeSniffer) against WordPress Coding Standards and show warnings and errors as annotations in your PRs without adding PHPCS as a dependency or a PHP CodeSniffer config.

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. The linting workflow of Block for Apple Maps is a good example how to use this action in practice.

Using markdown content in GitHub Actions summary

In May 2022, GitHub introduced the markdown support for the GitHub Actions summaries. This feature can help improve the developer experience by generating more useful reports to action summaries.

Planned

• Building a production-ready version into a stable branch or other location of choice.

Contributing

Want to help? Check out our contributing guidelines to get started.

Support Level

Active: 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.

Like what you see?