Cache PHP extensions in GitHub Actions

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 to see how to use this.

Contents

• PHP Support
• OS/Platform Support
• Usage
  • Inputs
  • Workflow
• License
• Contributions
• Support this project
• Dependencies

🎉 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	Security fixes only
7.3	Stable	Active
7.4	Stable	Active
8.0	Nightly	In development

☁️ OS/Platform Support

Virtual environment	YAML workflow label
Windows Server 2019	windows-latest or windows-2019
Ubuntu 20.04	ubuntu-20.04
Ubuntu 18.04	ubuntu-latest or ubuntu-18.04
Ubuntu 16.04	ubuntu-16.04
macOS Catalina 10.15	macos-latest or macOS-10.15

📝 Usage

Inputs

php-version (required)

• Specify the PHP version you want to setup.
• Accepts a string. For example '7.4'.
• See PHP support for supported PHP versions.

extensions (required)

• Specify the extensions you want to add or remove.
• Accepts a string in csv-format. For example mbstring, , xdebug, :opcache.
• Extensions prefixed with : are ignored.

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 and usage below for more info.

Workflow

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: ['7.2', '7.3', '7.4']
    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@v2

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

📜 License

The scripts and documentation in this project are released under the MIT License. This project has multiple dependencies. Their licenses can be found in their respective repositories.

👍 Contributions

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.

💖 Support this project

If this action helped you.

• Sponsor the project by subscribing on Patreon or by contributing using Paypal.
• Please star the project and share it with the community.
• If you blog, write about your experience of using this action.
• If you need any help using this, please contact me using Codementoru need any help using this, please contact me using Codementor

🔖 Dependencies

• Node.js dependencies