community.general.composer 模块 – PHP 的依赖项管理器

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您正在使用 ansible 软件包，则您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.general。您需要其他需求才能使用此模块，请参阅 需求 获取详细信息。

要在剧本中使用它，请指定： community.general.composer。

摘要

  • Composer 是一个用于 PHP 依赖项管理的工具。它允许您声明项目所需的依赖库，它将为您安装到项目中。

需求

以下需求是在执行此模块的主机上需要的。

  • php

  • 在 bin 路径中安装 composer（推荐 /usr/local/bin）或在 composer_executable 中指定

参数

参数

注释

apcu_autoloader

布尔值

使用 APCu 缓存已找到/未找到的类

选项

  • false ← (默认)

  • true

arguments

字符串

Composer 参数，例如所需包、版本等。

默认： ""

classmap_authoritative

布尔值

仅从 classmap 自动加载类。

隐式启用 optimize_autoloader。

尤其推荐用于生产环境，但运行可能需要一些时间。

选项

  • false ← (默认)

  • true

command

字符串

Composer 命令，例如“install”、“update”等。

默认： "install"

composer_executable

路径

在 community.general 3.2.0 中添加

远程主机上 composer 可执行文件的路径，如果 composer 不在 PATH 中或需要自定义 composer。

executable

别名：php_path

路径

远程主机上 PHP 可执行文件的路径，如果 PHP 不在 PATH 中。

global_command

布尔值

全局运行指定的命令。

选项

  • false ← (默认)

  • true

ignore_platform_reqs

布尔值

忽略 php、hhvm、lib-* 和 ext-* 需求，即使本地机器不满足这些需求也强制安装。

选项

  • false ← (默认)

  • true

no_dev

布尔值

禁用 require-dev 包的安装（参见 –no-dev）。

选项

  • false

  • true ← (默认)

no_plugins

布尔值

禁用所有插件（参见 –no-plugins）。

选项

  • false ← (默认)

  • true

no_scripts

布尔值

跳过在 composer.json 中定义的所有脚本的执行（参见 –no-scripts）。

选项

  • false ← (默认)

  • true

optimize_autoloader

布尔值

在自动加载器转储期间优化自动加载器（参见 –optimize-autoloader）。

将 PSR-0/4 自动加载转换为 classmap 以获得更快的自动加载器。

尤其推荐用于生产环境，但运行可能需要一些时间。

选项

  • false

  • true ← (默认)

prefer_dist

布尔值

即使对于开发版本也强制从包发行版安装（参见 –prefer-dist）。

选项

  • false ← (默认)

  • true

prefer_source

布尔值

尽可能强制从包源安装（参见 –prefer-source）。

选项

  • false ← (默认)

  • true

working_dir

路径

项目的目录（参见 –working-dir）。当命令不是全局运行时，这是必需的。

如果 global_command=true，则将被忽略。

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

处于 diff 模式时，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

备注

注意

  • 每次执行时始终追加的默认选项是 –no-ansi、–no-interaction 和 –no-progress（如果可用）。

  • 我们收到了关于如果 composer 由 Homebrew 安装，则在 macOS 上出现问题的报告。请使用官方安装方法以避免问题。

示例

- name: Download and installs all libs and dependencies outlined in the /path/to/project/composer.lock
  community.general.composer:
    command: install
    working_dir: /path/to/project

- name: Install a new package
  community.general.composer:
    command: require
    arguments: my/package
    working_dir: /path/to/project

- name: Clone and install a project with all dependencies
  community.general.composer:
    command: create-project
    arguments: package/package /path/to/project ~1.0
    working_dir: /path/to/project
    prefer_dist: true

- name: Install a package globally
  community.general.composer:
    command: require
    global_command: true
    arguments: my/package

作者

  • Dimitrios Tydeas Mengidis (@dmtrs)

  • René Moser (@resmo)