From fd29805fa1c15310f234857362cdfaa0124051e5 Mon Sep 17 00:00:00 2001
From: "Max P." <mail@0xMax42.io>
Date: Wed, 2 Jul 2025 13:56:09 +0200
Subject: [PATCH] docs(run.sh): update script documentation and help output

- Improve script documentation for clarity and consistency
- Extend help output to include detailed descriptions of options
---
 run.sh | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/run.sh b/run.sh
index 374d2d7..848abdc 100755
--- a/run.sh
+++ b/run.sh
@@ -1,12 +1,10 @@
 #!/usr/bin/env bash
 # run.sh – local wrapper for the “deb-changelog-action”
 #
-# This script
-#   1. clones https://git.0xmax42.io/actions/deb-changelog-action at the
-#      requested version into a temporary directory,
-#   2. installs git-cliff using the action’s helper script, and
-#   3. generates a Debian-style changelog **in the current working directory**
-#      via the action’s generator script.
+# Behaviour:
+#   • Clones https://git.0xmax42.io/actions/deb-changelog-action at the requested version into a temporary directory.
+#   • Installs git-cliff via the action’s helper script.
+#   • Generates a Debian-style changelog **in the current working directory** via the action’s generator script.
 #
 # Usage:
 #   ./run.sh --version v0 \
@@ -17,6 +15,16 @@
 #            [--output_file debian/changelog] \
 #            [--cliff_config path/to/cliff.toml]
 #
+# Options:
+#   --version <ver>        Action version to clone (required)
+#   --tag <tag>            Git tag used as starting point (required)
+#   --package_name <name>  Debian package name (required)
+#   --author_name <name>   Changelog author name (required)
+#   --author_email <mail>  Changelog author e-mail (required)
+#   --output_file <file>   Changelog path (default: debian/changelog)
+#   --cliff_config <file>  git-cliff config file (default: configs/cliff.debian.toml)
+#   -h, --help             Show this help message
+#
 # Notes:
 #   • Paths given for --output_file are interpreted relative to the directory
 #     where you run this script.
@@ -38,7 +46,7 @@ OUTPUT_FILE="debian/changelog"
 CLIFF_CONFIG=""
 # ───────────────────────────────────────────────
 
-show_help() { sed -n '2,25p' "$0"; }
+show_help() { sed -n '2,34p' "$0"; }
 
 # 1 ─ Parse CLI options ─────────────────────────
 while [[ $# -gt 0 ]]; do