nails / module-housekeeping
A generic orchestrator for cleanup and housekeeping routines in Nails applications
Requires
- php: >=8.3
- ext-zlib: *
- nails/common: dev-develop
- nails/module-console: dev-develop
- nails/module-cron: dev-develop
Requires (Dev)
- nails/module-admin: dev-develop
- phpstan/phpstan: ^2.0
- phpunit/phpunit: ^12.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
- dev-develop
- dev-feature/pre-new-admin
- dev-feat/quieter-housekeeping-log-develop
- dev-feat/quieter-housekeeping-log
- dev-feat/log-channel-thresholds-pre-new-admin
- dev-feat/log-channel-thresholds
- dev-feat/shorter-log-retention-pre-new-admin
- dev-feat/shorter-log-retention
- dev-fix/housekeeping-due-catch-up
- dev-feature/cdn-trash-housekeeping-loop
- dev-feat/drop-table-bordered
- dev-feature/log-file-archives
- dev-main
This package is auto-updated.
Last update: 2026-10-13 10:21:15 UTC
README
A generic orchestrator for cleanup routines in Nails applications.
Modules and apps define routines by implementing Nails\Housekeeping\Interfaces\Routine (normally by extending Nails\Housekeeping\Routine\Base) under src/Housekeeping/. Routines are discovered automatically, scheduled via a single housekeeping:run cron task, and every action is written to housekeeping-YYYY-MM-DD.php. A minute with nothing due produces no console output. The cron task does not copy a successful run into the cron log; a non-zero exit still is.
See the documentation for the authoring API, official traits, and console commands.