refactor(help): improve help extraction for scripts
All checks were successful
Auto Changelog & Release / release (push) Successful in 8s

- Standardize help section delimiters across scripts
- Update `show_help` functions to extract help text dynamically
- Enhance maintainability and readability of help-related code
This commit is contained in:
2025-07-02 16:41:31 +02:00
parent 93a3eb41fa
commit 656d08d74f
3 changed files with 30 additions and 3 deletions

View File

@@ -1,4 +1,5 @@
#!/usr/bin/env bash
#=== HELP START ===
# run.sh – local wrapper for the “deb-changelog-action”
#
# Behaviour:
@@ -32,6 +33,7 @@
# (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"
@@ -46,7 +48,14 @@ OUTPUT_FILE="debian/changelog"
CLIFF_CONFIG=""
# ───────────────────────────────────────────────
show_help() { sed -n '2,34p' "$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

View File

@@ -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

View File

@@ -1,4 +1,5 @@
#!/usr/bin/env bash
#=== HELP START ===
# install-git-cliff.sh – Installs the git-cliff binary
# Usage:
@@ -22,6 +23,7 @@
# 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"
@@ -39,7 +41,14 @@ USER_VERSION_SPECIFIED=false
# ───────────────────────────────────────────────
# 0 Help function
show_help() { sed -n '2,24p' "$0"; }
show_help() {
sed -n '/^#=== HELP START ===/,/^#=== HELP END ===/ {
/^#=== HELP START ===/d
/^#=== HELP END ===/d
s/^#//
p
}' "$0"
}
# 1 Parse options (keeps old single-arg form)
POSITIONAL=()