chore(changelog): update changelog for v0.2.3

This reverts commit a2a77a49b1.

CHANGELOG.md

@@ -2,6 +2,48 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.3](https://git.0xmax42.io/actions/deb-changelog-action/compare/v0.2.2..v0.2.3) - 2025-12-13
+
+### 🐛 Bug Fixes
+
+- *(changelog)* Normalize version hyphens to tildes in Debian changelog - ([a38586f](https://git.0xmax42.io/actions/deb-changelog-action/commit/a38586f52c48a830a8c8a5eda25a50eed40a782f))
+
+## [0.2.1](https://git.0xmax42.io/actions/deb-changelog-action/compare/v0.2.0..v0.2.1) - 2025-12-13
+
+### 🚜 Refactor
+
+- *(help)* Improve help extraction for scripts - ([656d08d](https://git.0xmax42.io/actions/deb-changelog-action/commit/656d08d74f299d3c90aebfa67eac74f37662568f))
+
+### ⚙️ Miscellaneous Tasks
+
+- *(scripts)* Improve install script readability and error handling - ([2a2ad79](https://git.0xmax42.io/actions/deb-changelog-action/commit/2a2ad79bb4990c1f14324180275814a274376970))
+
+## [0.2.0](https://git.0xmax42.io/actions/deb-changelog-action/compare/v0.1.1..v0.2.0) - 2025-07-02
+
+### 📚 Documentation
+
+- *(readme)* Update script reference in usage example - ([fb60cee](https://git.0xmax42.io/actions/deb-changelog-action/commit/fb60cee7482173db64f5946d493ac16d5ea6e57d))
+- *(run.sh)* Update script documentation and help output - ([fd29805](https://git.0xmax42.io/actions/deb-changelog-action/commit/fd29805fa1c15310f234857362cdfaa0124051e5))
+- *(script)* Improve help message layout and readability - ([b1644de](https://git.0xmax42.io/actions/deb-changelog-action/commit/b1644de411d789cb337ac250913a8aad2d53b40d))
+- *(run.sh)* Clarify version reference in comments - ([f1b790d](https://git.0xmax42.io/actions/deb-changelog-action/commit/f1b790d4e3ae7d5b2d2300405f6bfdb6898dc8d2))
+
+## [0.1.1](https://git.0xmax42.io/actions/deb-changelog-action/compare/v0.1.0..v0.1.1) - 2025-06-27
+
+### 🚀 Features
+
+- *(run)* Add version flag and enforce as required input - ([13cdeb8](https://git.0xmax42.io/actions/deb-changelog-action/commit/13cdeb80c0b88cbf76185dfd7a3910e472178677))
+- *(script)* Add script to generate Debian changelog locally - ([eaa9ca9](https://git.0xmax42.io/actions/deb-changelog-action/commit/eaa9ca9f45abab59590f0b58030a881ddbcb8dd4))
+
+### 🐛 Bug Fixes
+
+- *(configs)* Correct environment variable for author email - ([fba5c57](https://git.0xmax42.io/actions/deb-changelog-action/commit/fba5c57fd4ecbea544f45d2d381542eefba3bcd6))
+- *(run)* Ensure environment variables are passed - ([e689046](https://git.0xmax42.io/actions/deb-changelog-action/commit/e689046d01682da4496df446104c4a9eb694c8eb))
+- *(run)* Ensure environment variables are passed to script - ([c9930e7](https://git.0xmax42.io/actions/deb-changelog-action/commit/c9930e794915370e7f8e0d81337baa444ef93a85))
+
+### 📚 Documentation
+
+- *(readme)* Add usage instructions for changelog generator - ([d9d5363](https://git.0xmax42.io/actions/deb-changelog-action/commit/d9d5363a666425e9fe97d35dad3eaff3a9f99d03))
+
 ## [0.1.0] - 2025-06-27
 
 ### 🚀 Features

README.md

@@ -0,0 +1,24 @@
+# Debian Changelog Generator
+
+## External Usage
+
+This repository provides a one-liner to generate a Debian-style changelog using `git-cliff`.
+
+## Quick Usage
+
+You can run the generator directly from the URL:
+
+```bash
+curl -s https://git.0xmax42.io/actions/deb-changelog-action/raw/branch/main/bootstrap.sh | bash -s -- \
+  --tag v2.9.1 \
+  --package_name my-package \
+  --author_name "John Doe" \
+  --author_email "john@example.com"
+```
+
+Optional arguments:
+
+* `--output_file debian/changelog` (default)
+* `--cliff_config path/to/custom.toml`
+
+> ⚠️ This will clone the action to a temporary directory, install `git-cliff`, and write the changelog into your current working directory.

VERSION

@@ -1 +1 @@
-0.1.0
+0.2.3

bootstrap.sh

@@ -0,0 +1,109 @@
+#!/usr/bin/env bash
+#=== HELP START ===
+# run.sh – local wrapper for the “deb-changelog-action”
+#
+# 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 \
+#            --tag v2.9.1 \
+#            --package_name mypkg \
+#            --author_name  "Max Mustermann" \
+#            --author_email max@example.com \
+#            [--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.
+#   • If --cliff_config is omitted, the default config shipped with the action
+#     (configs/cliff.debian.toml) is used.
+#   • PACKAGE_NAME, AUTHOR_NAME, AUTHOR_EMAIL are exported so the TOML template
+#     can reference them (e.g. {{ get_env(name="PACKAGE_NAME") }}).
+#=== HELP END ===
+set -euo pipefail
+
+REPO_URL="https://git.0xmax42.io/actions/deb-changelog-action"
+
+# ───────────────────────────────────────────────
+VERSION=""
+TAG=""
+PACKAGE_NAME=""
+AUTHOR_NAME=""
+AUTHOR_EMAIL=""
+OUTPUT_FILE="debian/changelog"
+CLIFF_CONFIG=""
+# ───────────────────────────────────────────────
+
+show_help() {
+  sed -n '/^#=== HELP START ===/,/^#=== HELP END ===/ {
+    /^#=== HELP START ===/d
+    /^#=== HELP END ===/d
+    s/^#//
+    p
+  }' "$0"
+}
+
+# 1 ─ Parse CLI options ─────────────────────────
+while [[ $# -gt 0 ]]; do
+  case "$1" in
+    --version)       VERSION="$2";       shift 2 ;;
+    --tag)           TAG="$2";           shift 2 ;;
+    --package_name)  PACKAGE_NAME="$2";  shift 2 ;;
+    --author_name)   AUTHOR_NAME="$2";   shift 2 ;;
+    --author_email)  AUTHOR_EMAIL="$2";  shift 2 ;;
+    --output_file)   OUTPUT_FILE="$2";   shift 2 ;;
+    --cliff_config)  CLIFF_CONFIG="$2";  shift 2 ;;
+    -h|--help)       show_help; exit 0 ;;
+    *) echo "❌ Unknown option: $1"; show_help; exit 1 ;;
+  esac
+done
+
+# 2 ─ Validate mandatory inputs ────────────────
+[[ -z "$VERSION"       ]] && { echo "❌ --version is required";       exit 1; }
+[[ -z "$TAG"           ]] && { echo "❌ --tag is required";           exit 1; }
+[[ -z "$PACKAGE_NAME"  ]] && { echo "❌ --package_name is required";  exit 1; }
+[[ -z "$AUTHOR_NAME"   ]] && { echo "❌ --author_name is required";   exit 1; }
+[[ -z "$AUTHOR_EMAIL"  ]] && { echo "❌ --author_email is required";  exit 1; }
+
+# 3 ─ Prepare temporary clone ──────────────────
+TMP_DIR=$(mktemp -d)
+trap 'rm -rf "$TMP_DIR"' EXIT
+
+echo "📥 Cloning ${REPO_URL}@${VERSION} → $TMP_DIR"
+git clone --depth 1 --branch "$VERSION" "$REPO_URL" "$TMP_DIR" >/dev/null
+
+# 4 ─ Install git-cliff via helper script ──────
+bash "$TMP_DIR/scripts/install-git-cliff.sh"
+
+# 5 ─ Determine config path ────────────────────
+if [[ -z "$CLIFF_CONFIG" ]]; then
+  CLIFF_CONFIG="$TMP_DIR/configs/cliff.debian.toml"
+fi
+[[ ! -r "$CLIFF_CONFIG" ]] && { echo "❌ Config not found: $CLIFF_CONFIG"; exit 1; }
+
+# 6 ─ Generate changelog in CURRENT dir ────────
+echo "📝 Generating changelog (output → $OUTPUT_FILE)"
+env \
+  PACKAGE_NAME="$PACKAGE_NAME" \
+  AUTHOR_NAME="$AUTHOR_NAME" \
+  AUTHOR_EMAIL="$AUTHOR_EMAIL" \
+  bash "$TMP_DIR/scripts/generate-changelog.sh" \
+    -c "$CLIFF_CONFIG" \
+    -t "$TAG" \
+    -o "$OUTPUT_FILE"
+
+echo "✅ Changelog ready: $OUTPUT_FILE"

configs/cliff.debian.toml

@@ -1,6 +1,6 @@
 [changelog]
 body = """\
-{{ get_env(name="PACKAGE_NAME") }} ({% if version %}{{ version | trim_start_matches(pat="v") }}{% else %}0.0.0-1{% endif %}) unstable; urgency=medium\
+{{ get_env(name="PACKAGE_NAME") }} ({% if version %}{{ version | replace(from="-", to="~") | trim_start_matches(pat="v") }}{% else %}0.0.0-1{% endif %}) unstable; urgency=medium\
 {% for group, commits in commits | group_by(attribute="group") %}
   * {{ group | striptags | trim | upper_first }}:\
 {%   for commit in commits %}
@@ -8,7 +8,7 @@ body = """\
 {%   endfor %}\
 {% endfor %}
 
-  -- {{ get_env(name="AUTHOR_NAME") }} <{{ get_env(name="AUTHOR_MAIL") }}>  {% if version %}{{ now() | date(format="%a, %d %b %Y %H:%M:%S %z") }}{% else %}{{ now() | date(format="%a, %d %b %Y %H:%M:%S %z") }}{% endif %}
+ -- {{ get_env(name="AUTHOR_NAME") }} <{{ get_env(name="AUTHOR_EMAIL") }}>  {% if version %}{{ now() | date(format="%a, %d %b %Y %H:%M:%S %z") }}{% else %}{{ now() | date(format="%a, %d %b %Y %H:%M:%S %z") }}{% endif %}
 
 """
 

scripts/generate-changelog.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+#=== HELP START ===
 # generate-changelog.sh – generates a Debian-style changelog via git-cliff
 #
 # Usage:
@@ -16,6 +17,7 @@
 #   • Checks that the config file exists and is readable.
 #   • Ensures the parent directory of the output file exists (unless --debug).
 #   • Generates the changelog; removes a leading empty line.
+#=== HELP END ===
 set -euo pipefail
 
 # ───────────────────────────────────────────────
@@ -25,7 +27,14 @@ OUT_FILE=""
 DEBUG=false
 # ───────────────────────────────────────────────
 
-show_help() { sed -n '2,18p' "$0"; }
+show_help() {
+  sed -n '/^#=== HELP START ===/,/^#=== HELP END ===/ {
+    /^#=== HELP START ===/d
+    /^#=== HELP END ===/d
+    s/^#//
+    p
+  }' "$0"
+}
 
 # 1 Parse CLI options
 while [[ $# -gt 0 ]]; do

scripts/install-git-cliff.sh

@@ -1,17 +1,29 @@
 #!/usr/bin/env bash
-# install-git-cliff.sh – fetches the latest or specified git-cliff binary
-# Usage (back-compatible):
-#   sudo ./install-git-cliff.sh                          # latest version, default arch/dir
-#   sudo ./install-git-cliff.sh 2.9.1                    # specific version
-# Extended options:
-#   sudo ./install-git-cliff.sh -a x86_64-linux-musl [<ver>]   # custom arch
-#   sudo ./install-git-cliff.sh -d /opt/tools [<ver>]          # custom install dir
-#   sudo ./install-git-cliff.sh -n [<ver>]                     # dry-run (no install)
-#   sudo ./install-git-cliff.sh -h | --help                    # help
-#
+#=== HELP START ===
+# install-git-cliff.sh – Installs the git-cliff binary
+
+# Usage:
+#   sudo ./install-git-cliff.sh [options] [<version>]
+
+# Options:
+#   -a, --arch <triplet>   Target architecture (default: ${DEFAULT_ARCH_DISPLAY})
+#   -d, --dir  <path>      Installation directory (default: ${INSTALL_DIR_DEFAULT})
+#   -n, --dry-run          Download and verify, but do NOT install
+#   -h, --help             Show this help message
+
+# Arguments:
+#   <version>              git-cliff version to install (default: latest)
+
 # Behaviour:
-#   • If git-cliff is already in \$PATH and **no version** was requested, the script exits early.
-#   • If a specific version was requested, the installed version is compared; identical → exit, different → upgrade.
+#   • If git-cliff is already in PATH and no version was requested the script exits.
+#   • If a specific version was requested, the installed version is compared and
+#     only upgraded if it differs.
+
+# Supported architecture triplets (examples):
+#   aarch64-linux-gnu / musl / apple-darwin / pc-windows-msvc
+#   i686-linux-gnu / musl / pc-windows-msvc
+#   x86_64-linux-gnu / musl / apple-darwin / pc-windows-*
+#=== HELP END ===
 set -euo pipefail
 
 REPO="orhun/git-cliff"
@@ -19,7 +31,7 @@ REPO="orhun/git-cliff"
 # ───────────────────────────────────────────────
 # Defaults (internal vs. user-facing)
 ARCH_OS_DEFAULT="x86_64-unknown-linux-gnu"
-DEFAULT_ARCH_DISPLAY="${ARCH_OS_DEFAULT/-unknown-/}"  # shown to user → x86_64-linux-gnu
+DEFAULT_ARCH_DISPLAY="${ARCH_OS_DEFAULT/-unknown-/}" # shown to user → x86_64-linux-gnu
 INSTALL_DIR_DEFAULT="/usr/local/bin"
 ARCH_OS="$ARCH_OS_DEFAULT"
 INSTALL_DIR="$INSTALL_DIR_DEFAULT"
@@ -30,46 +42,46 @@ USER_VERSION_SPECIFIED=false
 
 # 0 Help function
 show_help() {
-  cat <<EOF
-install-git-cliff.sh – Installs the git-cliff binary
-
-Usage:
-  sudo ./install-git-cliff.sh [options] [<version>]
-
-Options:
-  -a, --arch <triplet>   Target architecture (default: ${DEFAULT_ARCH_DISPLAY})
-  -d, --dir  <path>      Installation directory (default: ${INSTALL_DIR_DEFAULT})
-  -n, --dry-run          Download and verify, but do NOT install
-  -h, --help             Show this help message
-
-Arguments:
-  <version>              git-cliff version to install (default: latest)
-
-Behaviour:
-  • If git-cliff is already in PATH and no version was requested the script exits.
-  • If a specific version was requested, the installed version is compared and
-    only upgraded if it differs.
-
-Supported architecture triplets (examples):
-  aarch64-linux-gnu / musl / apple-darwin / pc-windows-msvc
-  i686-linux-gnu / musl / pc-windows-msvc
-  x86_64-linux-gnu / musl / apple-darwin / pc-windows-*
-EOF
+  sed -n '/^#=== HELP START ===/,/^#=== HELP END ===/ {
+    /^#=== HELP START ===/d
+    /^#=== HELP END ===/d
+    s/^#//
+    p
+  }' "$0"
 }
 
 # 1 Parse options (keeps old single-arg form)
 POSITIONAL=()
 while [[ $# -gt 0 ]]; do
   case "$1" in
-    -h|--help) show_help; exit 0 ;;
-    -n|--dry-run) DRY_RUN=true; shift ;;
-    -a|--arch)
-      [[ $# -lt 2 ]] && { echo "❌ Option $1 requires an argument"; exit 1; }
-      ARCH_OS_INPUT="$2"; shift 2 ;;
-    -d|--dir)
-      [[ $# -lt 2 ]] && { echo "❌ Option $1 requires an argument"; exit 1; }
-      INSTALL_DIR="$2"; shift 2 ;;
-    *) POSITIONAL+=("$1"); shift ;;
+  -h | --help)
+    show_help
+    exit 0
+    ;;
+  -n | --dry-run)
+    DRY_RUN=true
+    shift
+    ;;
+  -a | --arch)
+    [[ $# -lt 2 ]] && {
+      echo "❌ Option $1 requires an argument"
+      exit 1
+    }
+    ARCH_OS_INPUT="$2"
+    shift 2
+    ;;
+  -d | --dir)
+    [[ $# -lt 2 ]] && {
+      echo "❌ Option $1 requires an argument"
+      exit 1
+    }
+    INSTALL_DIR="$2"
+    shift 2
+    ;;
+  *)
+    POSITIONAL+=("$1")
+    shift
+    ;;
   esac
 done
 if [[ ${#POSITIONAL[@]} -gt 0 ]]; then
@@ -105,8 +117,16 @@ if command -v git-cliff >/dev/null; then
 fi
 
 # 4 Check for required tools
-need() { command -v "$1" >/dev/null || { echo "$1 is missing"; exit 1; }; }
-need curl; need tar; need grep; need sed; need awk; need jq
+need() { command -v "$1" >/dev/null || {
+  echo "$1 is missing"
+  exit 1
+}; }
+need curl
+need tar
+need grep
+need sed
+need awk
+need jq
 
 # 5 Determine version → Fetch release JSON
 if [[ "$VERSION" == "latest" ]]; then
@@ -116,14 +136,23 @@ else
 fi
 
 echo "🔍 Fetching release info ($API_URL)…"
-JSON=$(curl -fsSL "$API_URL") || { echo "❌ Failed to fetch release info"; exit 1; }
+JSON=$(curl -fsSL "$API_URL") || {
+  echo "❌ Failed to fetch release info"
+  exit 1
+}
 
-VERSION=$(jq -r '.tag_name' <<< "$JSON") || { echo "❌ Could not extract version"; exit 1; }
+VERSION=$(jq -r '.tag_name' <<<"$JSON") || {
+  echo "❌ Could not extract version"
+  exit 1
+}
 
-ASSET_URL=$(jq -r '.assets[]?.browser_download_url' <<< "$JSON" |
+ASSET_URL=$(jq -r '.assets[]?.browser_download_url' <<<"$JSON" |
   grep -E "${ARCH_OS}\.(tar\.(gz|xz)|zip)$" | head -n1)
 
-[[ -z "$ASSET_URL" ]] && { echo "❌ Matching asset not found for architecture ${ARCH_OS}"; exit 1; }
+[[ -z "$ASSET_URL" ]] && {
+  echo "❌ Matching asset not found for architecture ${ARCH_OS}"
+  exit 1
+}
 
 ASSET_FILE=$(basename "$ASSET_URL")
 echo "📦 Downloading git-cliff ${VERSION} (${ASSET_FILE}) …"
@@ -132,21 +161,32 @@ curl -#L -o "${TMP}/${ASSET_FILE}" "$ASSET_URL"
 
 # 6 Extract based on file extension
 case "$ASSET_FILE" in
-  *.tar.gz|*.tgz) tar -C "$TMP" -xzf "${TMP}/${ASSET_FILE}" ;;
-  *.tar.xz)       tar -C "$TMP" -xJf "${TMP}/${ASSET_FILE}" ;;
-  *.zip)          need unzip; unzip -q "${TMP}/${ASSET_FILE}" -d "$TMP" ;;
-  *) echo "❌ Unknown archive format: $ASSET_FILE"; exit 1 ;;
+*.tar.gz | *.tgz) tar -C "$TMP" -xzf "${TMP}/${ASSET_FILE}" ;;
+*.tar.xz) tar -C "$TMP" -xJf "${TMP}/${ASSET_FILE}" ;;
+*.zip)
+  need unzip
+  unzip -q "${TMP}/${ASSET_FILE}" -d "$TMP"
+  ;;
+*)
+  echo "❌ Unknown archive format: $ASSET_FILE"
+  exit 1
+  ;;
 esac
 
 # 7 Locate & (maybe) install binary
 BIN_PATH=$(find "$TMP" -type f -name git-cliff -perm -u+x | head -n1)
-[[ -z "$BIN_PATH" ]] && { echo "❌ Binary not found"; exit 1; }
+[[ -z "$BIN_PATH" ]] && {
+  echo "❌ Binary not found"
+  exit 1
+}
 
 if $DRY_RUN; then
   echo "🧪 Dry-run: verified git-cliff binary at ${BIN_PATH}"
   echo "ℹ️  Would install to: ${INSTALL_DIR}/git-cliff (sudo install -m755 …)"
   echo "✅ git-cliff $("$BIN_PATH" --version) would be installed successfully"
 else
-  sudo install -m755 "$BIN_PATH" "${INSTALL_DIR}/git-cliff"
+  SUDO=""
+  [[ $EUID -eq 0 ]] || SUDO="sudo"
+  $SUDO install -m755 "$BIN_PATH" "${INSTALL_DIR}/git-cliff"
   echo "✅ git-cliff $(git-cliff --version) installed in ${INSTALL_DIR}"
 fi