Cache PHP extensions in GitHub Actions. This action has to be used along with shivammathur/setup-php and actions/cache GitHub Actions. It configures the environment required to cache PHP extensions. Refer to Usage section for details and example workflow.
PHP Version | Stability | Release Support |
---|---|---|
5.3 | Stable |
End of life |
5.4 | Stable |
End of life |
5.5 | Stable |
End of life |
5.6 | Stable |
End of life |
7.0 | Stable |
End of life |
7.1 | Stable |
End of life |
7.2 | Stable |
End of life |
7.3 | Stable |
End of life |
7.4 | Stable |
End of life |
8.0 | Stable |
End of life |
8.1 | Stable |
Security fixes only |
8.2 | Stable |
Active |
8.3 | Stable |
Active |
8.4 | Nightly |
In development |
Virtual environment | YAML workflow label |
---|---|
Ubuntu 24.04 | ubuntu-24.04 |
Ubuntu 22.04 | ubuntu-latest or ubuntu-22.04 |
Ubuntu 20.04 | ubuntu-20.04 |
Windows Server 2022 | windows-latest or windows-2022 |
Windows Server 2019 | windows-2019 |
macOS Sonoma 14.x | macos-14 |
macOS Ventura 13.x | macos-13 |
macOS Monterey 12.x | macos-latest or macos-12 |
Note: Support for self-hosted runners for the above operating systems is in beta. If you use this action on a self-hosted runner, please report any issues you find.
Use this GitHub Action when the extensions you are adding in setup-php are installed and take a long time to set up. If you are using extensions which have the result Installed and enabled
in the logs like pecl
extensions on Ubuntu
or extensions which have custom support, it is recommended to use this action to cache your extensions.
- Specify the PHP version you want to set up.
- Accepts a
string
. For example'8.0'
. - Accepts
latest
to set up the latest stable PHP version. - Accepts
nightly
to set up a nightly build from the master branch of PHP. - Accepts the format
d.x
, whered
is the major version. For example5.x
,7.x
and8.x
. - See PHP support for the supported PHP versions.
- If not specified, it looks for
php-version-file
input.
- Specify a file with the PHP version you want to set up.
- Accepts a
string
. For example'.phpenv-version'
. - See PHP support for the supported PHP versions.
- By default,
.php-version
file is used. - If not specified and the default
.php-version
file is not found, the latest stable PHP version is set up.
- Specify the extensions you want to set up.
- Accepts a
string
in csv-format. For examplembstring, xdebug, :opcache
. - Extensions prefixed with
:
are ignored in output cache key.
- Specify the key to identify the cache version.
- Accepts any
string
. For examplecache-v1
. - Changing this would reset the cache.
See action.yml and usage below for more info.
Cache extensions in a PHP workflow
jobs:
run:
runs-on: ${{ matrix.operating-system }}
strategy:
matrix:
operating-system: [ubuntu-latest, windows-latest, macos-latest]
php-versions: ['8.1', '8.2', '8.3']
name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
env:
extensions: intl, pcov
key: cache-v1 # can be any string, change to clear the extension cache.
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup cache environment
id: extcache
uses: shivammathur/cache-extensions@v1
with:
php-version: ${{ matrix.php-versions }}
extensions: ${{ env.extensions }}
key: ${{ env.key }}
- name: Cache extensions
uses: actions/cache@v4
with:
path: ${{ steps.extcache.outputs.dir }}
key: ${{ steps.extcache.outputs.key }}
restore-keys: ${{ steps.extcache.outputs.key }}
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php-versions }}
extensions: ${{ env.extensions }}
If you set up both TS
and NTS
PHP versions in your workflow, please add ${{ env.phpts }}
to key
and restore-keys
inputs in actions/cache
step in the above workflow to avoid a conflicting cache.
- name: Cache extensions
uses: actions/cache@v4
with:
path: ${{ steps.extcache.outputs.dir }}
key: ${{ steps.extcache.outputs.key }}-${{ env.phpts }}
restore-keys: ${{ steps.extcache.outputs.key }}-${{ env.phpts }}
The code and documentation in this project are under the MIT License. This project has multiple dependencies. Their licenses can be found in their respective repositories.
Contributions are welcome! See Contributor's Guide. If you face any issues while using this or want to suggest a feature/improvement, create an issue here.
This project is generously supported by many users and organisations via GitHub Sponsors.