stellarwp/pup

StellarWP's Project Utilities & Packager

1.3.8 2024-12-13 22:50 UTC

Requires

• php: ^7.2|^8.0
• composer/composer: *
• guzzlehttp/guzzle: ^7.0
• symfony/console: ^5.4
• symfony/filesystem: ^5.4
• symfony/process: ^5.4

Requires (Dev)

• codeception/codeception: ^4.2
• codeception/module-asserts: ^2.0.1
• codeception/module-cli: ^2.0
• codeception/module-phpbrowser: ^2.0.3
• lucatume/codeception-snapshot-assertions: ^0.2.4
• phpstan/phpstan: ^1.10.0

MIT

• StellarWP

README

This is a CLI utility built by StellarWP for running project build processes, sanity checks, and packaging into zips.

Docs

• Installation
  • Install in a project as a phar - recommended for most projects.
  • Install as a composer dependency - easy, but comes with some caveats.
  • Install globally as a phar - good option for your system.
  • Install globally as a git clone - another good option for your system.
• Configuration
  • Glob patterns - for your .distfiles and .distignore files.
  • Internationalization (i18n)
• Commands
  • pup build
  • pup check
    • pup check:tbd
    • pup check:version-conflict
  • pup clean
  • pup do
  • pup get-version
  • pup help
  • pup i18n
  • pup info
  • pup package
  • pup workflow
  • pup zip
  • pup zip-name
• Command flow for pup zip
• Checks
  • Default checks
  • Running all checks
  • Running specific checks
  • Creating custom checks
    • Simple checks
    • Class-based checks
• Workflows
  • Defining workflows
  • Calling workflows
  • Pseudo-workflows
• Examples
  • GitHub Workflow: Zipping - Breaks up the pup zip command into multiple steps so debugging is easy.