ansible.builtin.git 模块 – 从 Git 检出部署软件（或文件）

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使不指定 集合关键字，也可以使用简短的模块名称 git。但是，我们建议您使用 完全限定集合名称 (FQCN) ansible.builtin.git，以方便链接到模块文档，并避免与可能具有相同模块名称的其他集合发生冲突。

概要

• 管理 Git 存储库的检出以部署文件或软件。

要求

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

• git>=1.7.1（命令行工具）

参数

参数	注释
accept_hostkey 布尔值	将确保或不确保 -o StrictHostKeyChecking=no 作为 ssh 选项存在。 请注意，这将禁用针对中间人攻击的保护。 使用 OpenSSH >= 7.5 的用户可能希望使用 accept_newhostkey 或将 ssh_opts 设置为 StrictHostKeyChecking=accept-new，它不会消除中间人攻击问题，但它会将其限制在第一次尝试。 选项 false ← (默认值) true
accept_newhostkey 布尔值 添加到 ansible-core 2.12 中	从 OpenSSH 7.5 开始，可以使用 -o StrictHostKeyChecking=accept-new，它更安全，只接受不存在或相同的主机密钥。如果为 true，确保 -o StrictHostKeyChecking=accept-new 作为 ssh 选项存在。 选项 false ← (默认值) true
archive 路径	指定带有扩展名的归档文件路径。如果指定，将创建包含源树的树结构的指定格式的归档文件。允许的归档格式 [“zip”， “tar.gz”， “tar”， “tgz”]。 这将从本地目录克隆并执行 git archive，因为并非所有 git 服务器都支持 git archive。
archive_prefix 字符串 添加到 ansible-base 2.10 中	指定一个前缀，添加到归档中每个文件路径的开头。需要指定 archive。
bare 布尔值	如果为 true，存储库将作为裸存储库创建，否则将作为具有工作区的标准存储库创建。 选项 false ← (默认值) true
clone 布尔值	如果为 false，即使本地不存在存储库，也不克隆存储库。 选项 false true ← (默认值)
depth 整数	创建浅层克隆，历史记录被截断为指定数量的修订版。最小可能值为 1，否则忽略。需要 git>=1.9.1 才能正常工作。
dest 路径 / 必需	存储库应检出的路径。这等效于 git clone [repo_url] [directory]。在 repo 中命名的存储库不会追加到此路径，目标目录必须为空。此参数是必需的，除非 clone 设置为 false。
executable 路径	要使用的 git 可执行文件的路径。如果未提供，将使用解析二进制文件路径的正常机制。
force 布尔值	如果为 true，工作存储库中的任何修改过的文件都将被丢弃。在 0.7 之前，这始终为 true 并且无法禁用。在 1.9 之前，默认值为 true。 选项 false ← (默认值) true
gpg_allowlist 别名：gpg_whitelist 列表 / 元素=字符串 添加到 Ansible 2.9 中	一个受信任的 GPG 指纹列表，用于与 GPG 签名的提交的指纹进行比较。 仅在 verify_commit=yes 时使用。 由于此功能依赖于 git 的 --raw 标志来使用 verify-commit 和 verify-tag，因此使用此功能需要 Git 2.6+。 别名 gpg_allowlist 添加到版本 2.17 中。 别名 gpg_whitelist 已弃用，将在版本 2.21 中删除。 默认值： []
key_file 路径	在目标主机上指定可选的私钥文件路径，用于检出。 这将确保 IdentitiesOnly=yes 出现在 ssh_opts 中。
recursive 布尔值	如果为 false，存储库将在不使用 --recursive 选项的情况下克隆，跳过子模块。 选项 false true ← (默认值)
reference 字符串	参考存储库（参见 git clone --reference ...）。
refspec 字符串	添加要获取的额外 refspec。如果版本设置为无法从任何分支或标签访问的 SHA-1，则此选项可能需要指定包含 SHA-1 的 ref。使用与 git fetch 命令相同的语法。一个示例值可以是“refs/meta/config”。
remote 字符串	远程的名称。 默认值： "origin"
repo 别名：name 字符串 / 必需	git、SSH 或 HTTP(S) 协议地址的 Git 存储库。
separate_git_dir 路径 添加到 Ansible 2.7 中	放置克隆存储库的路径。如果指定，Git 存储库可以与工作区分离。
single_branch 布尔值 添加到 ansible-core 2.11 中	只克隆到指定修订版尖端的历史记录。 选项 false ← (默认值) true
ssh_opts 字符串	git 在用作协议时将传递给 ssh 的选项，它通过 git 的 GIT_SSH/GIT_SSH_COMMAND 环境变量工作。 对于较旧的版本，它将 GIT_SSH_OPTS（特定于此模块）追加到上述变量，或通过包装器脚本追加。 其他选项可以添加到此列表中，例如 key_file 和 accept_hostkey。 一个示例值可以是 -o StrictHostKeyChecking=no（虽然此特定选项最好通过 accept_hostkey 设置）。 该模块确保始终存在 BatchMode=yes，以避免提示。
track_submodules 布尔值	如果为 true，子模块将跟踪其主分支（或 .gitmodules 中指定的其他分支）上的最新提交。如果为 false，子模块将保持在主项目指定的版本。这等同于为 git submodule update 指定 --remote 标志。 选项 false ← (默认值) true
umask 任何	在执行任何检出或其他存储库维护操作之前设置的 umask。
更新 布尔值	如果 false，则不会从源存储库检索新版本。 诸如存档之类的操作将对现有（旧）存储库进行操作，并且可能无法响应对选项版本或远程的更改。 选项 false true ← (默认值)
verify_commit 布尔值	如果 true，在克隆或检出 version 时，验证 GPG 签名提交的签名。这需要安装 git 版本>=2.1.0。提交必须已签名，并且公钥必须存在于 GPG 密钥环中。 选项 false ← (默认值) true
版本 字符串	要检出的存储库版本。这可以是文字字符串 HEAD、分支名称、标签名称。它也可以是 *SHA-1* 哈希，在这种情况下，如果给定版本尚不可用，则需要指定 refspec。 默认值： "HEAD"

属性

属性	支持	描述
check_mode	支持：完全支持	可以在 check_mode 中运行并返回更改状态预测，而不会修改目标，如果不支持，则将跳过该操作。
diff_mode	支持：完全支持	在差异模式下，将返回有关更改内容（或可能在 check_mode 中需要更改的内容）的详细信息
平台	平台： posix	可以对其进行操作的目标操作系统/系列

注意

注意

• 如果任务似乎挂起，请首先验证远程主机是否在 known_hosts 中。SSH 将提示用户授权与远程主机的首次联系。为了避免此提示，一种解决方案是使用 accept_hostkey 选项。另一种解决方案是在调用 git 模块之前将远程主机公钥添加到 /etc/ssh/ssh_known_hosts 中，使用以下命令：ssh-keyscan -H remote_host.com >> /etc/ssh/ssh_known_hosts。

示例

- name: Git checkout
  ansible.builtin.git:
    repo: 'https://github.com/ansible/ansible.git'
    dest: /tmp/checkout
    version: release-0.22

- name: Read-write git checkout from github
  ansible.builtin.git:
    repo: [email protected]:ansible/ansible.git
    dest: /tmp/checkout

- name: Just ensuring the repo checkout exists
  ansible.builtin.git:
    repo: 'https://github.com/ansible/ansible.git'
    dest: /tmp/checkout
    update: no

- name: Just get information about the repository whether or not it has already been cloned locally
  ansible.builtin.git:
    repo: [email protected]:ansible/ansible.git
    dest: /tmp/checkout
    clone: no
    update: no

- name: Checkout a github repo and use refspec to fetch all pull requests
  ansible.builtin.git:
    repo: 'https://github.com/ansible/ansible.git'
    dest: /tmp/checkout
    refspec: '+refs/pull/*:refs/heads/*'

- name: Create git archive from repo
  ansible.builtin.git:
    repo: [email protected]:ansible/ansible.git
    dest: /tmp/checkout
    archive: /tmp/ansible.zip

- name: Clone a repo with separate git directory
  ansible.builtin.git:
    repo: 'https://github.com/ansible/ansible.git'
    dest: /tmp/checkout
    separate_git_dir: /tmp/repo

- name: Example clone of a single branch
  ansible.builtin.git:
    repo: [email protected]:ansible/ansible.git
    dest: /tmp/checkout
    single_branch: yes
    version: master

- name: Avoid hanging when http(s) password is missing
  ansible.builtin.git:
    repo: 'https://github.com/ansible/ansible.git'
    dest: /tmp/checkout
  environment:
    GIT_TERMINAL_PROMPT: 0 # reports "terminal prompts disabled" on missing password
    # or GIT_ASKPASS: /bin/true # for git before version 2.3.0, reports "Authentication failed" on missing password

返回值

常见返回值在 此处 有记录，以下是此模块独有的字段

键	描述
after 字符串	更新期间检索的存储库的最后提交版本。 返回：成功 示例： "4c020102a9cd6fe908c9a4a326a38f972f63a903"
before 字符串	存储库更新之前的提交版本，“null”表示新存储库。 返回：成功 示例： "67c04ebe40a003bda0efb34eacfb93b0cafdf628"
git_dir_before 字符串	如果更改了 .git 目录，则包含其原始路径。 返回：成功 示例： "/path/to/old/git/dir"
git_dir_now 字符串	如果更改了 .git 目录，则包含其新路径。 返回：成功 示例： "/path/to/new/git/dir"
remote_url_changed 布尔值	包含是否更改了远程 URL，为 True 或 False。 返回：成功 示例： true
warnings 字符串	如果由于 git 版本过旧而无法使用请求的功能，则列出警告。 返回：错误 示例： "git version is too old to fully support the depth argument. Falling back to full checkouts."

作者

• Ansible 核心团队

• Michael DeHaan

收藏链接

• 问题跟踪器
• 存储库（来源）
• 通讯