Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shivammathur/cache-extensions

:package: Cache PHP extensions in GitHub Actions
https://github.com/shivammathur/cache-extensions

cache github github-actions php php-action php-extensions

Last synced: 2 days ago
JSON representation

:package: Cache PHP extensions in GitHub Actions

Host: GitHub
URL: https://github.com/shivammathur/cache-extensions
Owner: shivammathur
License: mit
Created: 2020-02-13T01:47:40.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2025-01-05T15:04:11.000Z (9 days ago)
Last Synced: 2025-01-06T00:03:50.207Z (9 days ago)
Topics: cache, github, github-actions, php, php-action, php-extensions
Language: Shell
Homepage: https://github.com/marketplace/actions/cache-php-extensions
Size: 3.95 MB
Stars: 51
Watchers: 3
Forks: 6
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Cache PHP extensions in GitHub Actions




  

  

  

  



Cache PHP extensions in [GitHub Actions](https://github.com/features/actions "GitHub Actions"). This action has to be used along with [shivammathur/setup-php](https://github.com/shivammathur/setup-php "Setup PHP") and [actions/cache](https://github.com/actions/cache "Cache in GitHub Actions") GitHub Actions. It configures the environment required to cache PHP extensions. Refer to [Usage](#memo-usage "How to use this") section for details and example workflow.

## Contents

- [PHP Support](#tada-php-support)

- [OS/Platform Support](#cloud-osplatform-support)

- [Usage](#memo-usage)

  - [Inputs](#inputs)

  - [Workflow](#workflow)

  - [Thread Safe Setup](#thread-safe-setup)

- [License](#scroll-license)

- [Contributions](#1-contributions)

- [Support This Project](#sparkling_heart-support-this-project)

- [Dependencies](#package-dependencies)

## :tada: PHP Support

|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`|

## :cloud: OS/Platform Support

| 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 Sequoia 15.x  | `macos-15`                         |

| macOS Sonoma 14.x   | `macos-latest` or `macos-14`       |

| macOS Ventura 13.x  | `macos-13`                         |

**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.

## :memo: Usage

Use this GitHub Action when the extensions you are adding in [setup-php](https://github.com/shivammathur/setup-php "setup-php GitHub Action") 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.

### Inputs

#### `php-version` (optional)

- 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`, where `d` is the major version. For example `5.x`, `7.x` and `8.x`.

- See [PHP support](#tada-php-support) for the supported PHP versions.

- If not specified, it looks for `php-version-file` input.

#### `php-version-file` (optional)

- Specify a file with the PHP version you want to set up.

- Accepts a `string`. For example `'.phpenv-version'`.

- See [PHP support](#tada-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.

#### `extensions` (required)

- Specify the extensions you want to set up.

- Accepts a `string` in csv-format. For example `mbstring, xdebug, :opcache`.

- Extensions prefixed with `:` are ignored in output cache key.

#### `key` (required)

- Specify the key to identify the cache version.

- Accepts any `string`. For example `cache-v1`.

- Changing this would reset the cache.

See [action.yml](action.yml "Metadata for this GitHub Action") and usage below for more info.

### Workflow

> Cache extensions in a PHP workflow

```yaml

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 }}

```

### Thread Safe Setup

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.

```yaml

- 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 }}

```

## :scroll: License

The code and documentation in this project are under the [MIT License](LICENSE "License for shivammathur/cache-extensions"). This project has multiple [dependencies](https://github.com/shivammathur/cache-extensions/network/dependencies "Dependencies for this PHP Action"). Their licenses can be found in their respective repositories.

## :+1: Contributions

Contributions are welcome! See [Contributor's Guide](.github/CONTRIBUTING.md "shivammathur/cache-extensions contribution guide"). If you face any issues while using this or want to suggest a feature/improvement, create an issue [here](https://github.com/shivammathur/cache-extensions/issues "Issues reported").

## :sparkling_heart: Support This Project

This project is generously supported by many users and organisations via [GitHub Sponsors](https://github.com/sponsors/shivammathur).



## :package: Dependencies

- [Node.js dependencies](https://github.com/shivammathur/cache-extensions/network/dependencies "Node.js dependencies")