From ae0378cb094043f514315d87f96bf56d5aff1937 Mon Sep 17 00:00:00 2001
From: Emilien Escalle <emilien.escalle@escemi.com>
Date: Thu, 29 Oct 2026 18:50:28 +0100
Subject: [PATCH] docs: generate usage examples for release 0.2.0

---
 Makefile                       |  4 +---
 actions/ansible/test/README.md | 42 ++++++++++++++++++++++++++++++++++
 actions/vm/create/README.md    |  2 +-
 actions/vm/destroy/README.md   |  2 +-
 actions/vm/test/README.md      |  2 +-
 5 files changed, 46 insertions(+), 6 deletions(-)

diff --git a/Makefile b/Makefile
index 2eadbf5..5035ad4 100644
--- a/Makefile
+++ b/Makefile
@@ -31,9 +31,7 @@ ci: ## Execute local CI tasks
 	$(MAKE) test
 
 docs: ## Generate action documentation
-	npm exec --yes --package=@ci-dokumentor/cli@0.5.0 -- ci-dokumentor generate --source actions/vm/create/action.yml actions/vm/test/action.yml actions/vm/destroy/action.yml --repository git
-	# The new Ansible action has no released version for automatic usage examples.
-	npm exec --yes --package=@ci-dokumentor/cli@0.5.0 -- ci-dokumentor generate --source actions/ansible/test/action.yml --repository git --exclude-sections usage
+	npm exec --yes --package=@ci-dokumentor/cli@0.5.0 -- ci-dokumentor generate --source actions/ansible/test/action.yml actions/vm/create/action.yml actions/vm/test/action.yml actions/vm/destroy/action.yml --repository git
 
 #############################
 # Helpers
diff --git a/actions/ansible/test/README.md b/actions/ansible/test/README.md
index 80185a8..fb9646f 100644
--- a/actions/ansible/test/README.md
+++ b/actions/ansible/test/README.md
@@ -113,3 +113,45 @@ for matrix entries.
 This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).
 
 <!-- generated:end -->
+<!-- usage:start -->
+
+## Usage
+
+```yaml
+- uses: hoverkraft-tech/ci-github-iac/actions/ansible/test@5c4b7307d7a2c58a01a3b62607cebde65f96b0a2 # 0.2.0
+  with:
+    # Checkout-relative requirements file containing exactly one stable ansible-core==X.Y.Z pin.
+    # This input is required.
+    ansible-requirements: ""
+
+    # Checkout-relative playbook containing test assertions. This playbook is executed. Supply test-playbook or collection, exclusively.
+    test-playbook: ""
+
+    # One checked-out collection directory containing galaxy.yml. Use a matrix for multiple collections.
+    collection: ""
+
+    # Optional Python major.minor for collection sanity checks. Empty tests all versions supported by Ansible Core.
+    target-python-version: ""
+
+    # Optional checkout-relative inventory file for test playbook execution.
+    inventory: ""
+
+    # Optional checkout-relative ansible.cfg file for test playbook execution.
+    ansible-config: ""
+
+    # Optional checkout-relative first-party collection search directory containing ansible_collections.
+    collections-path: ""
+
+    # Optional checkout-relative Galaxy requirements file for third-party role and collection dependencies.
+    galaxy-requirements: ""
+
+    # Stable summary and PR comment title, distinct for each test step or matrix entry.
+    # Default: `Ansible test results`
+    report-name: Ansible test results
+
+    # Token for PR comments; requires pull-requests write. Fork and Dependabot comments are skipped.
+    # Default: `${{ github.token }}`
+    github-token: ${{ github.token }}
+```
+
+<!-- usage:end -->
diff --git a/actions/vm/create/README.md b/actions/vm/create/README.md
index f77cf9c..fc34f3e 100644
--- a/actions/vm/create/README.md
+++ b/actions/vm/create/README.md
@@ -87,7 +87,7 @@ application-specific resources such as remote browser devices.
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-iac/actions/vm/create@70843368d5f5f7b0a2cec1e8435d81cc40beee64 # 0.1.0
+- uses: hoverkraft-tech/ci-github-iac/actions/vm/create@5c4b7307d7a2c58a01a3b62607cebde65f96b0a2 # 0.2.0
   with:
     # Path to a Lima YAML file in the checkout. Plain mode is enforced.
     # This input is required.
diff --git a/actions/vm/destroy/README.md b/actions/vm/destroy/README.md
index 5deb3b3..fbcaff4 100644
--- a/actions/vm/destroy/README.md
+++ b/actions/vm/destroy/README.md
@@ -57,7 +57,7 @@ and cloud resource cleanup are outside scope.
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-iac/actions/vm/destroy@70843368d5f5f7b0a2cec1e8435d81cc40beee64 # 0.1.0
+- uses: hoverkraft-tech/ci-github-iac/actions/vm/destroy@5c4b7307d7a2c58a01a3b62607cebde65f96b0a2 # 0.2.0
   with:
     # Private runtime directory returned by vm/create; repeated deletion is safe.
     # This input is required.
diff --git a/actions/vm/test/README.md b/actions/vm/test/README.md
index c14188e..394b42e 100644
--- a/actions/vm/test/README.md
+++ b/actions/vm/test/README.md
@@ -101,7 +101,7 @@ No extra reporting steps are needed in the workflow.
 ## Usage
 
 ```yaml
-- uses: hoverkraft-tech/ci-github-iac/actions/vm/test@70843368d5f5f7b0a2cec1e8435d81cc40beee64 # 0.1.0
+- uses: hoverkraft-tech/ci-github-iac/actions/vm/test@5c4b7307d7a2c58a01a3b62607cebde65f96b0a2 # 0.2.0
   with:
     # Private runtime directory returned by vm/create.
     # This input is required.