FluidTYPO3 development helpers - test runners, coding standards sniffing, local git hook scripts
This package is auto-updated.
Last update: 2021-10-05 16:27:58 UTC
Test runners, coding standards sniffing, local git hook scripts, utilities
This package defines dependencies and contains wrapper scripts for easy validations of Fluid Powered TYPO3 project repositories
conforming to the coding style and contribution guidelines. The provided
./vendor/bin/make script can be used for local
testing and will install itself as a git
post-commit hook that executes after commits are made.
The same scripts can be used from a continuous integration context.
fluidtypo3-development you must add it as a composer dependency:
composer require --dev fluidtypo3/development:*
Note that this package should only be used in local development!
- composer (scripts are tailored to be executed from composer projects only)
xdebugextension (optional, but required for generating code coverage)
- PHPUnit configuration file present in
Documentation/Changelogdirectory if you use the
A few handy shell utilities are included with
fluidtypo3-development to help you perform a few of the tasks associated with
maintaining and developing official FluidTYPO3 repositories. These utilities are:
Inside this package:
./vendor/bin/changelogwhich can be used to automatically generate a change log for an up-coming version. The command is used by the
releasecommand as well. It takes one mandatory argument, the version number (e.g.
1.2.3) and one additional and optional argument, a "since" date (e.g.
2016/03/10for March 10th 2016). Executing the command generates a dedicated change log file in
Documentation/Changelog/$version.mdand updates the
CHANGELOG.mdfile to record the new log file.
./vendor/bin/stagewhich performs the standard staging steps for FluidTYPO3 extensions - makes sure the working copy is clean, checks out staging and merges development, runs unit tests and if succesful, pushes the result to the remote for continuous integration to do its work.
./vendor/bin/releasewhich releases an extension (which was staged immediately before that). Checks out the master branch, merges the staging branch into it, runs unit tests, generates a change log, raises the version number and commits a new (signed) tag. If all of this is succesful, the result is pushed to the remote and GitHub hooks deploy the extension to TER.
./vendor/bin/setversionwhich can be used to consistently update the version number when the repository is a TYPO3 extension. The script updates the
ext_emconf.phpfiles with a new version number and must be used for example as:
./vendor/bin/setversion 1.2.3 stable- which sets the version number to
1.2.3and stability to
./vendor/bin/uploadwhich is capable of uploading the current state of the extension to TER. Use this with great care; the utility is included in case the automatic TER uploads fail. Example:
./vendor/bin/upload . $username $password "Comment"where
$passwordare your/our official TYPO3 account credentials with access to the extension on TER.
In addition, all third-party commands such as
phpcs can be manually executed from the
For instructions on using those commands (with the exception of the two scripts above), run the command with the
Hooks are provided which prepare and validate commit messages that you make. You can install these by copying them into
.git/hooks/ folder. When this package is added as a dependency, you normally find the hooks we deliver in the path
./vendor/fluidtypo3/development/hooks - simply copy them from here to the applied hooks folder.
Every FluidTYPO3 extension is testable using a completely vanilla phpunit command:
Nothing else required. The command is the default phpunit CLI command and supports all the usual switches. This command is
also what gets executed as part of the
release CLI commands to ensure consistency before pushing anything.