You will need roughly 6 minutes to read this article.
We use PHPENV to manage PHP versions. We currently have 5.6, 7.0, 7.1, 7.2, 7.3 and 7.4 installed. These are aliases that are pointing to the specific 5.x.x and 7.x.x versions we have installed.
For a full list of installed versions (including patch level versions) open a SSH debug build and run the following command
By default we use 7.3
Specific versions: 5.6.40, 7.0.33, 7.1.33, 7.2.26, 7.3.13 and 7.4.1
Do not rely on the specific versions we have as this can change at any time and could break your build.
You can change the version you want to use by running
phpenv local PHP_VERSION in your setup commands.
phpenv local 7.3
You can access and change the php.ini file in
If you install a new executable through a pear package make sure to run
so phpenv is aware of the new executable and sets it up correctly
You can install dependencies through pear and composer in your setup commands.
If you want cache
composer dependencies during builds, please add the following environment variable to your build configuration.
To make sure that the dependency cache is used by all of your dependencies, please call
composer via the following snippet.
composer install --prefer-dist --no-interaction
Extensions can be installed through pecl. If you need any other tools or are having trouble getting an extension to build, please send us a message.
xdebug is installed and enabled on the build VMs. If you want to remove it, add the following command to your builds.
rm -f /home/rof/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini
pear install pear/PHP_CodeSniffer
composer install --no-interaction
pecl install -f memcache
To speed up Composer you can install packages from
dist by replacing
--prefer-dist. However as GitHub’s API is rate limited, you then might see errors similar to this:
- Installing phpunit/phpunit (3.7.37) Downloading: connection... Failed to download phpunit/phpunit from dist: Could not authenticate against github.com` Now trying to download from source
To avoid this create a new personal access token on GitHub. For the description you can use something like CodeShip Composer and you can unselect all scopes. Copy your personal access token and add it to the environment variables in your CodeShip project settings (on the Environment page) as
Then use the following Setup Commands in your CodeShip project settings:
composer config -g github-oauth.github.com $GITHUB_ACCESS_TOKEN composer install --prefer-dist --no-interaction
CodeShip supports essentially all popular PHP frameworks, such as Laravel, Symfony, CodeIgniter and CakePHP.
Additionally, all testing frameworks, such as phpunit and codeception, will work on CodeShip.
If you are running parallel test pipelines, you will want separate your tests into groups and call a group specifically in each pipeline. For instance:
Note that we do not officially support or integrate with this module and that it is possible for this to cause resource and build failure issues, as well.
When setting environment variables with PHP, the syntax can be either
$varname. Individual frameworks may have their own formatting. For instance, Symfony uses
%env(VAR_NAME)% for environment variables in configuration files, such as database configuration.
Due to PHP version issues, you may find it helpful to test your commands with different versions via an SSH debug session if tests are running differently on CodeShip compared to your local machine.
If you want to test against a running PHP Server you can use the builtin one to start a server in the current directory. It will serve files from this directory.
nohup bash -c "php -S 127.0.0.1:8000 2>&1 &" && sleep 1; cat nohup.out
You can access it in your tests on 127.0.0.1:8000.
Also take a look at the PHP built-in webserver docs in the PHP documentation
Thanks to Jeff Donios for the tip.
All commands must return an
exit code 0 to CodeShip to report a successful result, or any other error code to report an unsuccessful result. This means you must configure your test scripts to exit with a
0 status if they do not do so by default.
Note that if you need to install a custom version of PHPUnit, you can do so with the following commands:
composer global remove phpunit/phpunit composer global require phpunit/phpunit:7.*
If you need to install the Memcached extension for PHP 7 and up you may need to use this command to get it installed:
printf "/usr \n\n\n\n\n\n\nno\n" | pecl install memcached
\curl -sSL https://raw.githubusercontent.com/codeship/scripts/master/packages/libsodium.sh | bash -s
Following the install add this command to install with
LD_LIBRARY_PATH=$HOME/cache/libsodium/lib PKG_CONFIG_PATH=$HOME/cache/libsodium/lib/pkgconfig LDFLAGS="-L$HOME/cache/libsodium/lib" pecl install libsodium
Contact our support team or post on Stack Overflow using the tag
#codeship. Did you check the status page and changelog?
There are also several code examples and sample projects available for you to get started with.