GitHub Actions - WordPress Skeleton

Project short intro

This project is used as a base for setting up CI/CD using GitHub actions for new or existing projects. It uses GitHub Actions Library for actions inside the workflow. .github folder in the repository contains the main CI/CD scripts.

Setup CI/CD

To setup CI/CD in your project follow these steps:

0. If you're creating a site through EasyEngine v4, add flag --public-dir=current in creation for proper configuration and then delete the current folder (rm -r /opt/easyengine/sites/example.com/app/htdocs/current), it will get created by deployer in CI/CD.

1. Setup your repo according to the skeleton strucutre of this repo. In case of fresh projects, you can start with a direct clone of this repo. For existing projects you can take the .github folder.

git clone --depth=1 [email protected]:rtCamp/github-actions-wordpress-skeleton.git

2. Update hosts.yml

   1. Update branch blocks with required branches and corresponding server details.
   2. Update ci_script_options as per project needs.
      1. Setting vip: true will enable cloning of mu-plugins.
      2. wp-version can be set to latest for latest released version. Or it can be pinned to a specified by setting a value like: 5.0.3.
      3. Setup slack_channel, with the channel name you want to send notification to. If left empty, it will disable slack notifications.

3. Update GitHub secret and add VAULT_ADDR and VAULT_GITHUB_TOKEN secret. TODO: Add steps on how to setup VAULT_GITHUB_TOKEN.

Note: Steps 4 and 5 are required, only if the site has not been created with --public-dir=current EasyEngine flag

4. Update nginx webroot of the site to point to /var/www/htdocs/current. If you are using EasyEngine v4 then:

   1. Update the file: /opt/easyengine/sites/example.com/config/nginx/conf.d/main.conf and replace /var/www/htdocs with /var/www/htdocs/current
   2. Run ee site reload example.com.

5. Move wp-config.php inside htdocs folder.

mv /opt/easyengine/example.com/app/wp-config.php /opt/easyengine/example.com/app/htdocs/wp-config.php 

Customize the actions

GitHub actions library has the flexibility of customization to accomodate various scenarios.

To customize any particular file in the action, follow the folder structure of the library inside .github folder. File inside .github folder will override the default file in the action.

Example: If deploy.php needs to be customised, then in the library the file is present in deploy folder. So, placing it in location .github/deploy/deploy.php will override the one in action.

FAQs

Q: How to configure custom deploy.php?

A: You can take a reference of this deploy.php and create similar deploy.php with additional configurations as per need and place it in location .github/deploy/deploy.php.

---

Q: How to run composer install for plugins in CI/CD setup?

A: You can update the deply.php as stated above, and add a task to run composer install. Or you can override deploy.sh by placing it location .github/deploy/deploy.sh and add composer install line here.

---

Q: How to change phpcs inspections standards?

A: Take this phpcs.sh as the base file and place it in location .github/inspections/codesniffer/phpcs.sh. Then, update following lines to install standards according to the need of project.

---

Q: How to setup git repo for mu-plugins cloning for vip site?

A: By default, if vip: true is setup in hosts.yml, then https://github.com/Automattic/vip-mu-plugins-public repo is cloned. If any other repo is required, then it can be setup as env variable in action Deploy in main.workflow file.

---