mlocati / concrete5-since-tagger
Compare data between concrete5 versions and manages @since PHPDoc tags
dev-master
2019-09-30 15:27 UTC
Requires
- php: >=7.2
- doctrine/dbal: ^2.6
- doctrine/orm: ^2.6
- guzzlehttp/guzzle: ^6.3
- symfony/console: ^4.0
- vlucas/phpdotenv: ^3.4
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.15.1
This package is auto-updated.
Last update: 2024-10-29 05:17:03 UTC
README
When developing for multiple concrete5 versions, developers need to know when a class/interface/method/constant/... has been introduces.
The @since
phpdoc tag is the standard way to document this.
The process implement requires these steps:
- analyze all the concrete5 versions (starting from 5.7.0), extracting the defined classes/interfaces/methods/constants/...
This can be done with the
./bin/concrete5-since-tagger update
CLI command (to analyze all the concrete5 versions) and/or with the./bin/concrete5-since-tagger parse <version>
CLI command (to analyze/reanalyze a specific concrete5 version) - patching the corrent development version of concrete5, comparing it with the previously parsed versions.
This can be done with the
./bin/concrete5-since-tagger patch <path>
CLI command
Requirements
- A MySQL instance
- PHP 7.2+ and PHP 5.x (PHP 5.x is required for the analysis process)
- The
unzip
CLI command
Setup
- copy
.env.dist
to.env
and personalize it - run
composer install
- run
./bin/concrete5-since-tagger orm:schema-tool:create
to intialize the database
Typical usage
# Parse all the concrete5 versions ./bin/concrete5-since-tagger update # Patch the development version ./bin/concrete5-since-tagger patch /path/to/concrete5
Ready-to-use data
The update
command is a really time-consuming process: it needs to download and parse all the concrete5 releases.
If you don't want to do that, you can pre-populate the database with this SQL dump.