ansible.builtin.composer (v2.3.2.0-1) — module

Dependency Manager for PHP

| "added in version" 1.6 of ansible.builtin"

Authors: Dimitrios Tydeas Mengidis (@dmtrs), René Moser (@resmo)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.2.0.post1

Description

Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Downloads and installs all the libs and dependencies outlined in the /path/to/project/composer.lock
- composer:
    command: install
    working_dir: /path/to/project
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- composer:
    command: require
    arguments: my/package
    working_dir: /path/to/project
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Clone project and install with all dependencies
- composer:
    command: create-project
    arguments: package/package /path/to/project ~1.0
    working_dir: /path/to/project
    prefer_dist: yes

Inputs

    
no_dev:
    aliases:
    - no-dev
    choices:
    - true
    - false
    default: true
    description:
    - Disables installation of require-dev packages (see --no-dev).
    required: false

command:
    default: install
    description:
    - Composer command like "install", "update" and so on.
    required: false
    version_added: '1.8'
    version_added_collection: ansible.builtin

arguments:
    default: null
    description:
    - Composer arguments like required package, version and so on.
    required: false
    version_added: '2.0'
    version_added_collection: ansible.builtin

no_plugins:
    aliases:
    - no-plugins
    choices:
    - true
    - false
    default: false
    description:
    - Disables all plugins ( see --no-plugins ).
    required: false

no_scripts:
    aliases:
    - no-scripts
    choices:
    - true
    - false
    default: false
    description:
    - Skips the execution of all scripts defined in composer.json (see --no-scripts).
    required: false

prefer_dist:
    aliases:
    - prefer-dist
    choices:
    - true
    - false
    default: false
    description:
    - Forces installation from package dist even for dev versions (see --prefer-dist).
    required: false

working_dir:
    aliases:
    - working-dir
    default: null
    description:
    - Directory of your project (see --working-dir).
    required: true

prefer_source:
    aliases:
    - prefer-source
    choices:
    - true
    - false
    default: false
    description:
    - Forces installation from package sources when possible (see --prefer-source).
    required: false

optimize_autoloader:
    aliases:
    - optimize-autoloader
    choices:
    - true
    - false
    default: true
    description:
    - Optimize autoloader during autoloader dump (see --optimize-autoloader).
    - Convert PSR-0/4 autoloading to classmap to get a faster autoloader.
    - Recommended especially for production, but can take a bit of time to run so it is
      currently not done by default.
    required: false

ignore_platform_reqs:
    aliases:
    - ignore-platform-reqs
    choices:
    - true
    - false
    default: false
    description:
    - Ignore php, hhvm, lib-* and ext-* requirements and force the installation even if
      the local machine does not fulfill these.
    required: false
    version_added: '2.0'
    version_added_collection: ansible.builtin