Skip to content

MathieuLamiot/sybgo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

210 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sybgo - Monorepo

Since You've Been Gone — Sybgo plugin and its PHP library, managed as a monorepo.

Repository Structure

sybgo/
├── wp-plugin/    WordPress plugin (wp-media/sybgo)
├── lib/          PHP library (wp-media/sybgo-lib)
└── bin/          Developer tooling (dev-up.sh, dev-seed.sh, ...)

Local development

Boot a one-shot WordPress + MySQL + sybgo environment via @wordpress/env:

bin/dev-up.sh           # boot, activate plugin, seed demo content
bin/dev-up.sh --no-seed # boot only
bin/dev-up.sh --reset   # destroy + reboot fresh
bin/dev-down.sh         # stop (keeps data)

Requires Docker (Rancher Desktop or Docker Desktop), Node.js, and Composer. After boot: http://localhost:8888/wp-admin — login admin / password. The plugin source at wp-plugin/ and the library at lib/ are bind-mounted, so host edits are live.

Packages

wp-plugin — WordPress Plugin

Tracks meaningful changes on a WordPress site and sends weekly email digests.

  • Development Guide — local setup, running tests, contributing
  • Requirements: WordPress 5.0+, PHP 7.4+, Composer
cd wp-plugin
composer install

# Code standards
composer phpcs
composer phpcs:fix

# Tests
composer test-unit
composer test-integration

lib — PHP Library

Core event tracking, report generation, email delivery, and AI summarization logic.

cd lib
composer install

# Code standards
composer phpcs

# Tests
composer test-unit
composer test-integration

CI

Six scoped workflows in .github/workflows/, each triggered only on changes to its package:

Workflow Scope Trigger path
phpcs-plugin.yml Plugin code style wp-plugin/**
phpcs-lib.yml Lib code style lib/**
phpstan-plugin.yml Plugin static analysis wp-plugin/**
phpstan-lib.yml Lib static analysis lib/**
phpunit-plugin.yml Plugin tests + coverage wp-plugin/**
phpunit-lib.yml Lib tests + coverage lib/**

License

GPL-2.0-or-later

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors