Documentation

PLEASE NOTE: This document applies to latest version and not to the latest stable release v2.21

Documentation for other releases can be found by using the version selector in the top right of any doc page.

patch

Apply patch files to source files using the system patch command.

Attributes

check_mode:
  support: full

Parameters

Parameter	Required	Type	Values	Description
src	true	string		Path to the patch file to apply.
dest	true	string		Destination file to patch.
basedir		string		Base directory for applying the patch.
state		string	present absent	Whether the patch should be applied or reversed. `present` applies the patch, `absent` reverses it. [default: `"present"`]
backup		boolean		Create a backup of the original file before patching. [default: `false`]
dry_run		boolean		Test the patch without actually applying it. [default: `false`]
strip		integer		Number of leading path components to strip from file paths in the patch. [default: `0`]

Examples

- name: Apply security patch to application
  patch:
    src: /tmp/security.patch
    dest: /opt/app/src/main.rs
    backup: true

- name: Apply patch with stripped leading paths
  patch:
    src: /tmp/fix.patch
    dest: /opt/app/src/config.rs
    strip: 1

- name: Test patch without applying
  patch:
    src: /tmp/test.patch
    dest: /opt/app/src/main.rs
    dry_run: true

- name: Reverse a previously applied patch
  patch:
    src: /tmp/rollback.patch
    dest: /opt/app/src/main.rs
    state: absent