Skip to content

chore: Collaborating on Hackday 3 #235

chore: Collaborating on Hackday 3

chore: Collaborating on Hackday 3 #235

Workflow file for this run

# This does the following:
# 1. Detects modified plugins that have phpcs.xml configuration
# 2. Runs PHP Code Quality checks on those plugins using the custom action
# 3. Creates a matrix job for each plugin that has a quality configuration
# Bonus: This means you can have plugin specific badges e.g.
# [![Code Quality](https://img.shields.io/github/check-runs/wpengine/hwptoolkit/main?checkName=hwp-previews%20php%20code%20quality%20checks&label=Code%20Quality%20Checks)](https://github.com/wpengine/hwptoolkit/actions)
name: Code Quality
on:
push:
branches:
- main
paths:
- 'plugins/*/**.php'
pull_request:
paths:
- 'plugins/*/**.php'
jobs:
detect-plugins:
runs-on: ubuntu-latest
name: Detect plugins has php code quality configuration
outputs:
plugins: ${{ steps.detect.outputs.plugins }}
has-plugins: ${{ steps.detect.outputs.has-plugins }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Get changed plugin directory
id: plugin
run: |
if [ "${{ github.event_name }}" = "push" ]; then
bash .github/scripts/get_plugin_slug.sh main
else
bash .github/scripts/get_plugin_slug.sh ${{ github.event.pull_request.base.sha }} ${{ github.sha }}
fi
- name: Detect changed plugins with quality config
id: detect
run: |
if [ -z "${{ steps.plugin.outputs.slug }}" ]; then
echo "No plugin slug detected"
echo "plugins=[]" >> $GITHUB_OUTPUT
echo "has-plugins=false" >> $GITHUB_OUTPUT
exit 0
fi
PLUGIN="${{ steps.plugin.outputs.slug }}"
if [ -f "plugins/$PLUGIN/phpcs.xml" ]; then
echo "plugins=[\"$PLUGIN\"]" >> $GITHUB_OUTPUT
echo "has-plugins=true" >> $GITHUB_OUTPUT
echo "✅ Found phpcs.xml for plugin: $PLUGIN"
else
echo "plugins=[]" >> $GITHUB_OUTPUT
echo "has-plugins=false" >> $GITHUB_OUTPUT
echo "ℹ️ No phpcs.xml found for plugin: $PLUGIN, skipping quality checks"
fi
quality-checks:
needs: detect-plugins
if: needs.detect-plugins.outputs.has-plugins == 'true'
runs-on: ubuntu-latest
strategy:
matrix:
plugin: ${{ fromJson(needs.detect-plugins.outputs.plugins) }}
fail-fast: false
name: ${{ matrix.plugin }} php code quality checks
steps:
- name: Checkout
uses: actions/checkout@v4
- name: PHP Code Quality for ${{ matrix.plugin }}
uses: ./.github/actions/code-quality
with:
working-directory: plugins/${{ matrix.plugin }}