Skip to content

Dev #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dannorthern merged 5 commits into from
Aug 12, 2025
Merged

Dev #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ae333bf
test: convert wp-schema from custom test framework to WP_Mock
dannorthern Aug 11, 2025
a84fd7b
feat: add CI workflow for automated testing
dannorthern Aug 11, 2025
64366ab
fix: remove composer.json version bumping from release workflow
dannorthern Aug 12, 2025
4f184f1
Merge branch 'main' into dev
dannorthern Aug 12, 2025
a2224f7
fix: remove invalid script descriptions from composer.json
dannorthern Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 13 additions & 20 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,8 @@ jobs:
php-version: '8.2'
tools: composer:v2

- name: Update composer.json version
if: contains(fromJSON('["composer.json", "package.json"]'), 'composer.json')
run: |
if [ -f composer.json ]; then
jq '.version = "${{ steps.version.outputs.version_number }}"' composer.json > composer.tmp.json
mv composer.tmp.json composer.json
fi
# Skip composer.json version update - version tracked via git tags only
# This prevents merge conflicts between branches

- name: Update package.json version
if: contains(fromJSON('["package.json"]'), 'package.json')
Expand All @@ -77,9 +72,7 @@ jobs:
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"

if [ -f composer.json ]; then
git add composer.json
fi
# Skip adding composer.json - version tracked via git tags only
if [ -f package.json ]; then
git add package.json package-lock.json
fi
Expand Down Expand Up @@ -124,25 +117,25 @@ jobs:
OTHER=$(echo "$COMMITS" | grep -vE "^- (feat|feature|fix|bugfix|docs|documentation|style|formatting|refactor|refactoring|test|tests|chore|build|ci):" || true)

if [ -n "$FEATURES" ]; then
CHANGELOG="$CHANGELOG"$'\n'"### 🚀 Features"$'\n'"$FEATURES"$'\n'
CHANGELOG="$CHANGELOG"$'\n'"### Features"$'\n'"$FEATURES"$'\n'
fi
if [ -n "$FIXES" ]; then
CHANGELOG="$CHANGELOG"$'\n'"### 🐛 Bug Fixes"$'\n'"$FIXES"$'\n'
CHANGELOG="$CHANGELOG"$'\n'"### Bug Fixes"$'\n'"$FIXES"$'\n'
fi
if [ -n "$DOCS" ]; then
CHANGELOG="$CHANGELOG"$'\n'"### 📚 Documentation"$'\n'"$DOCS"$'\n'
CHANGELOG="$CHANGELOG"$'\n'"### Documentation"$'\n'"$DOCS"$'\n'
fi
if [ -n "$REFACTOR" ]; then
CHANGELOG="$CHANGELOG"$'\n'"### ♻️ Refactoring"$'\n'"$REFACTOR"$'\n'
CHANGELOG="$CHANGELOG"$'\n'"### Refactoring"$'\n'"$REFACTOR"$'\n'
fi
if [ -n "$TEST" ]; then
CHANGELOG="$CHANGELOG"$'\n'"### ✅ Tests"$'\n'"$TEST"$'\n'
CHANGELOG="$CHANGELOG"$'\n'"### Tests"$'\n'"$TEST"$'\n'
fi
if [ -n "$CHORE" ]; then
CHANGELOG="$CHANGELOG"$'\n'"### 🔧 Maintenance"$'\n'"$CHORE"$'\n'
CHANGELOG="$CHANGELOG"$'\n'"### Maintenance"$'\n'"$CHORE"$'\n'
fi
if [ -n "$OTHER" ]; then
CHANGELOG="$CHANGELOG"$'\n'"### 📦 Other Changes"$'\n'"$OTHER"$'\n'
CHANGELOG="$CHANGELOG"$'\n'"### Other Changes"$'\n'"$OTHER"$'\n'
fi

CHANGELOG="$CHANGELOG"$'\n'"**Full Changelog**: "
Expand Down Expand Up @@ -196,7 +189,7 @@ jobs:
uses: softprops/action-gh-release@v1
with:
tag_name: ${{ steps.version.outputs.version }}
name: ${{ env.PACKAGE_DISPLAY_NAME }} ${{ steps.version.outputs.version }}
name: ${{ steps.version.outputs.version }}
body_path: release_notes.md
draft: false
prerelease: ${{ github.event.inputs.prerelease == 'true' }}
Expand All @@ -209,9 +202,9 @@ jobs:
- name: Release summary
if: success()
run: |
echo "✅ Release created successfully!"
echo "Release created successfully!"
echo ""
echo "📦 To use this version in other packages:"
echo "To use this version in other packages:"
echo ""
echo " \"require\": {"
echo " \"${{ env.COMPOSER_NAMESPACE }}\": \"${{ steps.version.outputs.version_number }}\""
Expand Down
125 changes: 125 additions & 0 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
name: Tests

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:

jobs:
test:
runs-on: ubuntu-latest

strategy:
fail-fast: false
matrix:
php-version: ['8.1', '8.2', '8.3', '8.4']

name: PHP ${{ matrix.php-version }}

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php-version }}
coverage: none
tools: composer:v2

- name: Get composer cache directory
id: composer-cache
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT

- name: Cache dependencies
uses: actions/cache@v4
with:
path: ${{ steps.composer-cache.outputs.dir }}
key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
restore-keys: ${{ runner.os }}-composer-

- name: Validate composer.json
run: composer validate --strict --no-check-lock

- name: Install dependencies
run: composer install --prefer-dist --no-progress --no-interaction

- name: Security check for vulnerabilities
run: composer audit --no-dev

- name: Run PHPUnit tests
run: composer test

coverage:
name: Code Coverage
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
coverage: xdebug
tools: composer:v2

- name: Install dependencies
run: composer install --prefer-dist --no-progress --no-interaction

- name: Run PHPUnit with coverage
run: vendor/bin/phpunit --coverage-text --coverage-clover=coverage.xml

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
file: ./coverage.xml
flags: unittests
fail_ci_if_error: false

code-quality:
name: Code Quality
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
coverage: none
tools: composer:v2

- name: Install dependencies
run: composer install --prefer-dist --no-progress --no-interaction

- name: Run PHPCS coding standards check
run: composer lint

- name: Check PHP compatibility
run: composer phpcompat

test-status:
name: CI Status
runs-on: ubuntu-latest
needs: [test, coverage, code-quality]
if: always()

steps:
- name: Check results
run: |
if [ "${{ needs.test.result }}" == "success" ] && [ "${{ needs.code-quality.result }}" == "success" ] && [ "${{ needs.coverage.result }}" == "success" ]; then
echo "✅ All checks passed!"
exit 0
else
echo "❌ Some checks failed!"
[ "${{ needs.test.result }}" != "success" ] && echo " - Tests: Failed"
[ "${{ needs.coverage.result }}" != "success" ] && echo " - Coverage: Failed"
[ "${{ needs.code-quality.result }}" != "success" ] && echo " - Code Quality: Failed"
exit 1
fi
54 changes: 47 additions & 7 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,49 @@
/vendor/
composer.lock
# Various things
.sass-cache
node_modules
.ftppass
sftpCache.json
bower_components
.DS_Store
.idea/
.vscode/
bin/tasks
_srcMaps/

# Exclude composer dependencies in the vendor directory
/vendor
composer.lock

# Log files
*.log
*.cache
/node_modules/
.env

#various
wp-content/uploads/sites/*/gravity_forms
wp-content/uploads/sites/*/wp-migrate-db
wp-content/uploads/wpo-plugins-tables-list.json



# Project Files
dist
backstop_data

# Editors
*.esproj
*.tmproj
*.tmproject
tmtags
.*.sw[a-z]
*.un~
Session.vim
*.swp
.vscode

# Mac OSX
.DS_Store
._*
.Spotlight-V100
.Trashes

# Windows
Thumbs.db
Desktop.ini
/debug.log
19 changes: 19 additions & 0 deletions .phpcs.xml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0"?>
<ruleset name="WP Schema">
<description>Coding standards for WP Schema package</description>

<!-- What to scan -->
<file>.</file>

<!-- Exclude patterns -->
<exclude-pattern>/vendor/*</exclude-pattern>
<exclude-pattern>/tests/*</exclude-pattern>
<exclude-pattern>*.js</exclude-pattern>
<exclude-pattern>*.css</exclude-pattern>

<!-- Use Built North Coding Standards -->
<rule ref="BuiltNorth"/>

<!-- PHP Compatibility -->
<config name="testVersion" value="8.1-"/>
</ruleset>
1 change: 1 addition & 0 deletions .phpunit.result.cache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"version":1,"defects":{"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testSetIfNotEmpty":4,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testFromArray":3,"BuiltNorth\\WPSchema\\Tests\\Providers\\OrganizationProviderTest::testGetPieces":4,"BuiltNorth\\WPSchema\\Tests\\Providers\\OrganizationProviderTest::testFilterHook":3,"BuiltNorth\\Schema\\Tests\\AppTest::testSingletonInstance":4,"BuiltNorth\\Schema\\Tests\\AppTest::testInitialization":4,"BuiltNorth\\Schema\\Tests\\AppTest::testGetRegistry":4,"BuiltNorth\\Schema\\Tests\\AppTest::testGetGraphBuilder":4,"BuiltNorth\\Schema\\Tests\\AppTest::testGetTypeRegistry":4,"BuiltNorth\\Schema\\Tests\\AppTest::testRegisterProvider":4,"BuiltNorth\\Schema\\Tests\\AppTest::testRegisterProviderWithInvalidClass":4,"BuiltNorth\\Schema\\Tests\\AppTest::testDoubleInitialization":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testBasicCreation":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testSetAndGet":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testFluentInterface":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testSetWithEmptyValues":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testAddReference":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testToArray":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testFromArray":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testHas":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testRemove":4,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testMerge":4,"BuiltNorth\\Schema\\Tests\\Providers\\OrganizationProviderTest::testCanProvide":4,"BuiltNorth\\Schema\\Tests\\Providers\\OrganizationProviderTest::testGetPriority":4,"BuiltNorth\\Schema\\Tests\\Providers\\OrganizationProviderTest::testGetPieces":4,"BuiltNorth\\Schema\\Tests\\Providers\\OrganizationProviderTest::testFilterHook":4,"BuiltNorth\\WPSchema\\Tests\\AppTest::testInitialization":3,"BuiltNorth\\WPSchema\\Tests\\AppTest::testGetRegistry":3,"BuiltNorth\\WPSchema\\Tests\\AppTest::testGetGraphBuilder":3,"BuiltNorth\\WPSchema\\Tests\\AppTest::testGetTypeRegistry":3,"BuiltNorth\\WPSchema\\Tests\\AppTest::testRegisterProvider":3,"BuiltNorth\\WPSchema\\Tests\\AppTest::testRegisterProviderWithInvalidClass":3,"BuiltNorth\\WPSchema\\Tests\\AppTest::testDoubleInitialization":3},"times":{"BuiltNorth\\WPSchema\\Tests\\AppTest::testSingletonInstance":0.001,"BuiltNorth\\WPSchema\\Tests\\AppTest::testInitialization":0.022,"BuiltNorth\\WPSchema\\Tests\\AppTest::testGetRegistry":0,"BuiltNorth\\WPSchema\\Tests\\AppTest::testGetGraphBuilder":0,"BuiltNorth\\WPSchema\\Tests\\AppTest::testGetTypeRegistry":0,"BuiltNorth\\WPSchema\\Tests\\AppTest::testRegisterProvider":0,"BuiltNorth\\WPSchema\\Tests\\AppTest::testRegisterProviderWithInvalidClass":0,"BuiltNorth\\WPSchema\\Tests\\AppTest::testDoubleInitialization":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testBasicCreation":0.001,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testSetAndGet":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testFluentInterface":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testSetIfNotEmpty":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testAddReference":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testToArray":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testFromArray":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testHas":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testRemove":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testMerge":0,"BuiltNorth\\WPSchema\\Tests\\Providers\\OrganizationProviderTest::testCanProvide":0,"BuiltNorth\\WPSchema\\Tests\\Providers\\OrganizationProviderTest::testGetPriority":0,"BuiltNorth\\WPSchema\\Tests\\Providers\\OrganizationProviderTest::testGetPieces":0.001,"BuiltNorth\\WPSchema\\Tests\\Providers\\OrganizationProviderTest::testFilterHook":0,"BuiltNorth\\WPSchema\\Tests\\Graph\\SchemaPieceTest::testSetWithEmptyValues":0,"BuiltNorth\\Schema\\Tests\\AppTest::testSingletonInstance":0.001,"BuiltNorth\\Schema\\Tests\\AppTest::testInitialization":0,"BuiltNorth\\Schema\\Tests\\AppTest::testGetRegistry":0,"BuiltNorth\\Schema\\Tests\\AppTest::testGetGraphBuilder":0,"BuiltNorth\\Schema\\Tests\\AppTest::testGetTypeRegistry":0,"BuiltNorth\\Schema\\Tests\\AppTest::testRegisterProvider":0,"BuiltNorth\\Schema\\Tests\\AppTest::testRegisterProviderWithInvalidClass":0,"BuiltNorth\\Schema\\Tests\\AppTest::testDoubleInitialization":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testBasicCreation":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testSetAndGet":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testFluentInterface":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testSetWithEmptyValues":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testAddReference":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testToArray":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testFromArray":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testHas":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testRemove":0,"BuiltNorth\\Schema\\Tests\\Graph\\SchemaPieceTest::testMerge":0,"BuiltNorth\\Schema\\Tests\\Providers\\OrganizationProviderTest::testCanProvide":0,"BuiltNorth\\Schema\\Tests\\Providers\\OrganizationProviderTest::testGetPriority":0,"BuiltNorth\\Schema\\Tests\\Providers\\OrganizationProviderTest::testGetPieces":0,"BuiltNorth\\Schema\\Tests\\Providers\\OrganizationProviderTest::testFilterHook":0,"BuiltNorth\\WPSchema\\Tests\\Providers\\OrganizationProviderTest::testGetPiecesWithLogo":0}}
38 changes: 21 additions & 17 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{
"name": "builtnorth/wp-schema",
"description": "Comprehensive schema generation for WordPress with SEO optimization and logo support",
"version": "1.0.1",
"type": "library",
"license": "GPL-2.0-or-later",
"authors": [
Expand All @@ -25,33 +24,38 @@
},
"require-dev": {
"phpunit/phpunit": "^9.0",
"squizlabs/php_codesniffer": "^3.0",
"phpcompatibility/php-compatibility": "^9.0"
"10up/wp_mock": "^1.0",
"mockery/mockery": "^1.5",
"builtnorth/coding-standards": "*"
},
"config": {
"optimize-autoloader": true,
"sort-packages": true
"sort-packages": true,
"allow-plugins": {
"dealerdirect/phpcodesniffer-composer-installer": true
}
},
"scripts": {
"test": "phpunit",
"test:unit": "phpunit --testsuite Unit",
"test:coverage": "phpunit --coverage-html coverage",
"test:watch": "phpunit-watcher watch",
"cs": "phpcs",
"cs:fix": "phpcbf",
"analyze": "phpstan analyze",
"check": [
"@cs",
"@test"
]
"lint": "phpcs",
"lint:fix": "phpcbf",
"phpcs": "phpcs",
"phpcs:summary": "phpcs --report=summary",
"phpcbf": "phpcbf",
"phpcompat": "phpcs -p inc --standard=PHPCompatibility --runtime-set testVersion 8.1-"
},
"scripts-descriptions": {
"test": "Run PHPUnit tests",
"test:unit": "Run PHPUnit unit tests only",
"test:coverage": "Run PHPUnit tests with HTML coverage report",
"test:watch": "Watch for changes and run tests automatically",
"cs": "Check code style with PHP_CodeSniffer",
"cs:fix": "Fix code style issues with PHP_CodeSniffer",
"analyze": "Run static analysis with PHPStan",
"check": "Run all quality checks (code style and tests)"
"lint": "Check code style with PHP_CodeSniffer",
"lint:fix": "Fix code style issues with PHP_CodeSniffer",
"phpcs": "Check code style with PHP_CodeSniffer",
"phpcs:summary": "Show summary of code style issues",
"phpcbf": "Fix code style issues with PHP_CodeSniffer",
"phpcompat": "Check PHP compatibility"
},
"minimum-stability": "stable",
"prefer-stable": true
Expand Down
Loading