Files
actions/php-composer/README.md
Ismo Vuorinen 7061aafd35 chore: add tests, update docs and actions (#299)
* docs: update documentation

* feat: validate-inputs has it's own pyproject

* security: mask DOCKERHUB_PASSWORD

* chore: add tokens, checkout, recrete docs, integration tests

* fix: add `statuses: write` permission to pr-lint
2025-10-18 13:09:19 +03:00

3.4 KiB

ivuorinen/actions/php-composer

Run Composer Install

Description

Runs Composer install on a repository with advanced caching and configuration.

Inputs

name description required default
php

PHP Version to use.

true 8.4
extensions

Comma-separated list of PHP extensions to install

false mbstring, xml, zip, curl, json
tools

Comma-separated list of Composer tools to install

false composer:v2
args

Arguments to pass to Composer.

false --no-progress --prefer-dist --optimize-autoloader
composer-version

Composer version to use (1 or 2)

false 2
stability

Minimum stability (stable, RC, beta, alpha, dev)

false stable
cache-directories

Additional directories to cache (comma-separated)

false ""
token

GitHub token for private repository access

false ""
max-retries

Maximum number of retry attempts for Composer commands

false 3

Outputs

name description
lock

composer.lock or composer.json file hash

php-version

Installed PHP version

composer-version

Installed Composer version

cache-hit

Indicates if there was a cache hit

Runs

This action is a composite action.

Usage

- uses: ivuorinen/actions/php-composer@main
  with:
    php:
    # PHP Version to use.
    #
    # Required: true
    # Default: 8.4

    extensions:
    # Comma-separated list of PHP extensions to install
    #
    # Required: false
    # Default: mbstring, xml, zip, curl, json

    tools:
    # Comma-separated list of Composer tools to install
    #
    # Required: false
    # Default: composer:v2

    args:
    # Arguments to pass to Composer.
    #
    # Required: false
    # Default: --no-progress --prefer-dist --optimize-autoloader

    composer-version:
    # Composer version to use (1 or 2)
    #
    # Required: false
    # Default: 2

    stability:
    # Minimum stability (stable, RC, beta, alpha, dev)
    #
    # Required: false
    # Default: stable

    cache-directories:
    # Additional directories to cache (comma-separated)
    #
    # Required: false
    # Default: ""

    token:
    # GitHub token for private repository access
    #
    # Required: false
    # Default: ""

    max-retries:
    # Maximum number of retry attempts for Composer commands
    #
    # Required: false
    # Default: 3