mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-06-18 21:39:12 +02:00
Update daily_README.yaml
This commit is contained in:
Alexandre
271
.github/workflows/daily_README.yaml
vendored
271
.github/workflows/daily_README.yaml
vendored
@@ -1,188 +1,131 @@
|
|||||||
# yamllint disable rule:line-length
|
#!/usr/bin/env bash
|
||||||
---
|
|
||||||
name: Generate README
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: 0 17 * * *
|
|
||||||
workflow_dispatch: null
|
|
||||||
|
|
||||||
jobs:
|
set -euo pipefail
|
||||||
README_updater:
|
|
||||||
if: github.repository_owner == 'alexbelgium'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout Repo
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
|
|
||||||
- name: Install yq (and jq)
|
# Ensure yq is installed (mikefarah/yq v4+)
|
||||||
run: |
|
if ! command -v yq &>/dev/null; then
|
||||||
sudo apt-get update
|
echo "yq is required (https://github.com/mikefarah/yq), please install it in your CI or local environment"
|
||||||
sudo apt-get install -y jq
|
exit 1
|
||||||
YQ_VERSION="v4.44.3"
|
fi
|
||||||
sudo wget -qO /usr/local/bin/yq "https://github.com/mikefarah/yq/releases/download/${YQ_VERSION}/yq_linux_amd64"
|
|
||||||
sudo chmod +x /usr/local/bin/yq
|
|
||||||
|
|
||||||
- name: Create README file
|
echo "Starting"
|
||||||
shell: bash
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
echo "Starting"
|
|
||||||
|
|
||||||
# Prepare template
|
cp .templates/.README.md README2.md
|
||||||
cp .templates/.README.md README2.md
|
ADDONSLINE="$(sed -n '/%%ADDONS_LIST%%/=' README2.md)"
|
||||||
ADDONSLINE="$(sed -n '/%%ADDONS_LIST%%/=' README2.md)"
|
sed -i "/%%ADDONS_LIST%%/d" README2.md
|
||||||
sed -i "/%%ADDONS_LIST%%/d" README2.md
|
|
||||||
|
|
||||||
# Helper to locate config
|
# Step 1: Rename folders by name field in config
|
||||||
get_cfg() {
|
for f in $(find . -maxdepth 1 -type d ! -name '.' | sort -r); do
|
||||||
local dir="$1"
|
CONFIG=""
|
||||||
for ext in json yaml yml; do
|
[ -f "$f/config.json" ] && CONFIG="$f/config.json"
|
||||||
if [ -f "$dir/config.$ext" ]; then
|
[ -z "$CONFIG" ] && [ -f "$f/config.yaml" ] && CONFIG="$f/config.yaml"
|
||||||
echo "$dir/config.$ext"
|
[ -z "$CONFIG" ] && continue
|
||||||
return 0
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
return 1
|
|
||||||
}
|
|
||||||
|
|
||||||
# Sort/rename addons
|
if [[ "$CONFIG" == *.json ]]; then
|
||||||
for f in $( find -- * -maxdepth 0 -type d | sort -r ); do
|
NAME=$(jq -r '.name // empty' "$CONFIG")
|
||||||
CFG="$(get_cfg "$f" || true)"
|
else
|
||||||
if [ -n "${CFG:-}" ]; then
|
NAME=$(yq -r '.name // empty' "$CONFIG")
|
||||||
NAME="$(yq -r '.name // ""' "$CFG")"
|
fi
|
||||||
if [ -n "$NAME" ] && [ "$f" != "$NAME" ]; then
|
|
||||||
echo "$f" > "$f/oldname"
|
|
||||||
mv "$f" "$NAME"
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Populate template
|
if [[ -n "$NAME" && "$f" != "./$NAME" ]]; then
|
||||||
find -- * -maxdepth 0 -type d | sort -r | while read -r f; do
|
echo "${f#./}" > "$f/oldname"
|
||||||
CFG="$(get_cfg "$f" || true)"
|
mv "$f" "./$NAME"
|
||||||
[ -n "${CFG:-}" ] || continue
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
echo "Processing $f"
|
# Step 2: Populate README with addons list
|
||||||
|
find . -maxdepth 1 -type d ! -name '.' | sort -r | while read -r f; do
|
||||||
|
CONFIG=""
|
||||||
|
[ -f "$f/config.json" ] && CONFIG="$f/config.json"
|
||||||
|
[ -z "$CONFIG" ] && [ -f "$f/config.yaml" ] && CONFIG="$f/config.yaml"
|
||||||
|
[ -z "$CONFIG" ] && continue
|
||||||
|
|
||||||
# Handle folder rename reference
|
# Helper functions
|
||||||
if [ -f "$f/oldname" ]; then FOLDERNAME="$(cat "$f/oldname")"; else FOLDERNAME="$f"; fi
|
get_field() {
|
||||||
EXT="${CFG##*.}"
|
local field="$1"
|
||||||
BADGE_KIND="json"
|
if [[ "$CONFIG" == *.json ]]; then
|
||||||
[[ "$EXT" =~ ^ya?ml$ ]] && BADGE_KIND="yaml"
|
jq -r "$field // empty" "$CONFIG"
|
||||||
|
else
|
||||||
|
yq -r "$field // empty" "$CONFIG"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
# Extract values
|
get_array() {
|
||||||
NAME="$(yq -r '.name // ""' "$CFG")"
|
local field="$1"
|
||||||
DESCRIPTION="$(yq -r '.description // ""' "$CFG")"
|
if [[ "$CONFIG" == *.json ]]; then
|
||||||
PANEL_ICON="$(yq -r '.panel_icon // ""' "$CFG")"
|
jq -r "$field // empty | @sh" "$CONFIG" | tr -d "'"
|
||||||
SCHEMA_STR="$(yq -o=json '.schema // {}' "$CFG" | tr -d '\n' || true)"
|
else
|
||||||
SERVICES="$(yq -r '.services[]? // empty' "$CFG" | tr '\n' ' ' || true)"
|
yq -r "$field // empty | @sh" "$CONFIG" | tr -d "'"
|
||||||
FULL_ACCESS="$(yq -r '.full_access // false' "$CFG" || true)"
|
fi
|
||||||
INGRESS="$(yq -r '.ingress // false' "$CFG" || true)"
|
}
|
||||||
|
|
||||||
# Normalize arch array
|
# Info extraction
|
||||||
ARCHS="$(yq -r '.arch // [] | join(" ")' "$CFG" || true)"
|
if [ -f "$f/oldname" ]; then FOLDERNAME="$(cat "$f/oldname")"; else FOLDERNAME="${f#./}"; fi
|
||||||
|
NAME="$(get_field '.name')"
|
||||||
|
DESCRIPTION="$(get_field '.description')"
|
||||||
|
|
||||||
# Icon (mdi:)
|
# Icon
|
||||||
if [ -n "$PANEL_ICON" ] && [ "$PANEL_ICON" != "null" ]; then
|
ICON_RAW="$(get_field '.panel_icon')"
|
||||||
ICON_NAME="${PANEL_ICON#*:}"
|
if [[ "$ICON_RAW" != "null" && -n "$ICON_RAW" ]]; then
|
||||||
ICON=""
|
ICON="${ICON_RAW#*:}"
|
||||||
else
|
ICON=""
|
||||||
ICON=""
|
else
|
||||||
fi
|
ICON=""
|
||||||
|
fi
|
||||||
|
|
||||||
sed -i "$ADDONSLINE"'{G;}' README2.md
|
# Insert new line for this addon
|
||||||
|
sed -i "$ADDONSLINE"'{G;}' README2.md
|
||||||
|
|
||||||
# Features
|
# Badges
|
||||||
[[ "$SCHEMA_STR" == *"localdisks"* ]] && sed -i "$ADDONSLINE"'a ![localdisks][localdisks-badge]' README2.md
|
[[ "$(get_field '.schema')" == *"localdisks"* ]] && sed -i "$ADDONSLINE"'a ![localdisks][localdisks-badge]' README2.md
|
||||||
[[ "$SCHEMA_STR" == *"networkdisks"* ]] && sed -i "$ADDONSLINE"'a ![smb][smb-badge]' README2.md
|
[[ "$(get_field '.schema')" == *"networkdisks"* ]] && sed -i "$ADDONSLINE"'a ![smb][smb-badge]' README2.md
|
||||||
[[ "$FULL_ACCESS" == "true" ]] && sed -i "$ADDONSLINE"'a ![full_access][full_access-badge]' README2.md
|
[[ "$(get_field '.full_access')" == "true" ]] && sed -i "$ADDONSLINE"'a ![full_access][full_access-badge]' README2.md
|
||||||
[[ "$SERVICES" == *"mqtt"* ]] && sed -i "$ADDONSLINE"'a ![mqtt][mqtt-badge]' README2.md
|
|
||||||
[[ "$SERVICES" == *"mysql"* ]] && sed -i "$ADDONSLINE"'a ![MariaDB][mariadb-badge]' README2.md
|
|
||||||
[[ "$INGRESS" == "true" ]] && sed -i "$ADDONSLINE"'a ![ingress][ingress-badge]' README2.md
|
|
||||||
|
|
||||||
# --- Architecture shields (with architecture name + color) ---
|
SERVICES="$(get_array '.services[]')"
|
||||||
make_arch_badge() {
|
[[ "$SERVICES" == *"mqtt"* ]] && sed -i "$ADDONSLINE"'a ![mqtt][mqtt-badge]' README2.md
|
||||||
local arch="$1"
|
[[ "$SERVICES" == *"mysql"* ]] && sed -i "$ADDONSLINE"'a ![MariaDB][mariadb-badge]' README2.md
|
||||||
local color="$2"
|
|
||||||
echo ""
|
|
||||||
}
|
|
||||||
|
|
||||||
if [[ " $ARCHS " == *" armv7 "* ]]; then
|
[[ "$(get_field '.ingress')" == "true" ]] && sed -i "$ADDONSLINE"'a ![ingress][ingress-badge]' README2.md
|
||||||
sed -i "$ADDONSLINE"'a '"$(make_arch_badge 'armv7' 'brightgreen')"' README2.md
|
|
||||||
else
|
|
||||||
sed -i "$ADDONSLINE"'a '"$(make_arch_badge 'armv7' 'orange')"' README2.md
|
|
||||||
fi
|
|
||||||
if [[ " $ARCHS " == *" amd64 "* ]]; then
|
|
||||||
sed -i "$ADDONSLINE"'a '"$(make_arch_badge 'amd64' 'brightgreen')"' README2.md
|
|
||||||
else
|
|
||||||
sed -i "$ADDONSLINE"'a '"$(make_arch_badge 'amd64' 'orange')"' README2.md
|
|
||||||
fi
|
|
||||||
if [[ " $ARCHS " == *" aarch64 "* ]]; then
|
|
||||||
sed -i "$ADDONSLINE"'a '"$(make_arch_badge 'aarch64' 'brightgreen')"' README2.md
|
|
||||||
else
|
|
||||||
sed -i "$ADDONSLINE"'a '"$(make_arch_badge 'aarch64' 'orange')"' README2.md
|
|
||||||
fi
|
|
||||||
# -------------------------------------------------------------
|
|
||||||
|
|
||||||
[[ -f "$f/updater.json" ]] && sed -i "$ADDONSLINE"'a ![Update](https://img.shields.io/badge/dynamic/json?label=Updated&query=%24.last_update&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2F'"$FOLDERNAME"'%2Fupdater.json)' README2.md
|
ARCHS="$(get_array '.arch[]')"
|
||||||
|
[[ "$ARCHS" == *"armv7"* ]] && sed -i "$ADDONSLINE"'a ![armv7][armv7-badge]' README2.md || sed -i "$ADDONSLINE"'a ![armv7no][armv7no-badge]' README2.md
|
||||||
|
[[ "$ARCHS" == *"amd64"* ]] && sed -i "$ADDONSLINE"'a ![amd64][amd64-badge]' README2.md || sed -i "$ADDONSLINE"'a ![amd64no][amd64no-badge]' README2.md
|
||||||
|
[[ "$ARCHS" == *"aarch64"* ]] && sed -i "$ADDONSLINE"'a ![aarch64][aarch64-badge]' README2.md || sed -i "$ADDONSLINE"'a ![aarch64no][aarch64no-badge]' README2.md
|
||||||
|
|
||||||
sed -i "$ADDONSLINE"'a   ![Version](https://img.shields.io/badge/dynamic/'"$BADGE_KIND"'?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2F'"$FOLDERNAME"'%2Fconfig.'"$EXT"')' README2.md || true
|
[ -f "$f/updater.json" ] && sed -i "$ADDONSLINE"'a ![Update](https://img.shields.io/badge/dynamic/json?label=Updated&query=%24.last_update&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2F'"$FOLDERNAME"'%2Fupdater.json)' README2.md
|
||||||
sed -i "$ADDONSLINE"'a ✓ '"$ICON"' ['"$NAME"']('"$FOLDERNAME"'/) : '"$DESCRIPTION\\n" README2.md
|
|
||||||
done
|
|
||||||
|
|
||||||
# Restore original folder names
|
if [[ "$CONFIG" == *.json ]]; then
|
||||||
echo "Restoring folder names..."
|
sed -i "$ADDONSLINE"'a   ![Version](https://img.shields.io/badge/dynamic/json?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Falexbelgium%2Fhassio-addons%2Fmaster%2F'"$FOLDERNAME"'%2Fconfig.json)' README2.md
|
||||||
find -- * -maxdepth 0 -type d | sort -r | while read -r f; do
|
else
|
||||||
if [ -f "$f/oldname" ]; then
|
sed -i "$ADDONSLINE"'a   ' README2.md
|
||||||
NAME="$(cat "$f/oldname")"
|
fi
|
||||||
rm "$f/oldname"
|
|
||||||
mv "$f" "$NAME"
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
# Global stats
|
sed -i "$ADDONSLINE"'a ✓ '"$ICON"' ['"$NAME"']('"$FOLDERNAME"'/) : '"$DESCRIPTION\\n" README2.md
|
||||||
echo "Updating stats..."
|
done
|
||||||
STATS_DOWNLOADS="$(awk 'NR==2{print $1}' Stats)"
|
|
||||||
STATS_CFG_COUNT="$(
|
|
||||||
find . -mindepth 2 -maxdepth 2 -type f \
|
|
||||||
-regextype posix-extended \
|
|
||||||
-regex '.*/config\.(json|ya?ml)$' \
|
|
||||||
| wc -l
|
|
||||||
)"
|
|
||||||
sed -i "s|%%STATS_DOWNLOADS%%|$STATS_DOWNLOADS|g" README2.md
|
|
||||||
sed -i "s|%%STATS_ADDONS%%|$STATS_CFG_COUNT|g" README2.md
|
|
||||||
STATS_ONE="$(awk 'NR==3{print $(NF)}' Stats)"
|
|
||||||
STATS_TWO="$(awk 'NR==4{print $(NF)}' Stats)"
|
|
||||||
STATS_THREE="$(awk 'NR==5{print $(NF)}' Stats)"
|
|
||||||
sed -i "s|%%STATS_ONE%%|${STATS_ONE^}|g" README2.md
|
|
||||||
sed -i "s|%%STATS_TWO%%|${STATS_TWO^}|g" README2.md
|
|
||||||
sed -i "s|%%STATS_THREE%%|${STATS_THREE^}|g" README2.md
|
|
||||||
|
|
||||||
# Breakdown per arch
|
# Step 3: Restore folder names if changed
|
||||||
echo "Breakdown per arch..."
|
echo "Restore structure..."
|
||||||
STATS_ARMV7="$(awk '{SUM+=$3}END{print SUM}' Stats2)"
|
find . -maxdepth 1 -type d ! -name '.' | sort -r | while read -r f; do
|
||||||
STATS_AMD64="$(awk '{SUM+=$4}END{print SUM}' Stats2)"
|
[ -f "$f/oldname" ] && NAME="$(cat "$f/oldname")" && rm "$f/oldname" && mv "$f" "./$NAME"
|
||||||
STATS_AARCH64="$(awk '{SUM+=$5}END{print SUM}' Stats2)"
|
done
|
||||||
STATS_DOWNLOADS=$(( STATS_ARMV7 + STATS_AMD64 + STATS_AARCH64 ))
|
echo "... done"
|
||||||
if [ "$STATS_DOWNLOADS" -gt 0 ]; then
|
|
||||||
PCT_ARMV7="$(awk -v a="$STATS_ARMV7" -v t="$STATS_DOWNLOADS" 'BEGIN{printf "%.0f", a/t*100}')"
|
|
||||||
PCT_AMD64="$(awk -v a="$STATS_AMD64" -v t="$STATS_DOWNLOADS" 'BEGIN{printf "%.0f", a/t*100}')"
|
|
||||||
PCT_AARCH64="$(awk -v a="$STATS_AARCH64" -v t="$STATS_DOWNLOADS" 'BEGIN{printf "%.0f", a/t*100}')"
|
|
||||||
else
|
|
||||||
PCT_ARMV7=0; PCT_AMD64=0; PCT_AARCH64=0
|
|
||||||
fi
|
|
||||||
|
|
||||||
sed -i "s|%%STATS_ARMV7%%|armv7: ${PCT_ARMV7}%|g" README2.md
|
# Step 4: Stats (count both config.json and config.yaml)
|
||||||
sed -i "s|%%STATS_AMD64%%|amd64: ${PCT_AMD64}%|g" README2.md
|
echo "Global stats..."
|
||||||
sed -i "s|%%STATS_AARCH64%%|aarch64: ${PCT_AARCH64}%|g" README2.md
|
STATS_DOWNLOADS="$(awk 'NR==2{print $1}' Stats)"
|
||||||
|
TOTAL_ADDONS=$(find . -type f \( -name "config.json" -o -name "config.yaml" \) | wc -l)
|
||||||
|
sed -i "s|%%STATS_DOWNLOADS%%|$STATS_DOWNLOADS|g" README2.md
|
||||||
|
sed -i "s|%%STATS_ADDONS%%|$TOTAL_ADDONS|g" README2.md
|
||||||
|
STATS_ONE="$(awk 'NR==3{print $(NF)}' Stats)"
|
||||||
|
STATS_TWO="$(awk 'NR==4{print $(NF)}' Stats)"
|
||||||
|
STATS_THREE="$(awk 'NR==5{print $(NF)}' Stats)"
|
||||||
|
sed -i "s|%%STATS_ONE%%|${STATS_ONE^}|g" README2.md
|
||||||
|
sed -i "s|%%STATS_TWO%%|${STATS_TWO^}|g" README2.md
|
||||||
|
sed -i "s|%%STATS_THREE%%|${STATS_THREE^}|g" README2.md
|
||||||
|
echo "... done"
|
||||||
|
|
||||||
echo "Stats completed."
|
# Add any additional stats or breakdowns here as in your original
|
||||||
|
|
||||||
mv README2.md README.md
|
# Final: Replace template if changed
|
||||||
echo "README generated successfully."
|
mv README2.md README.md
|
||||||
|
echo "... done"
|
||||||
- name: Commit if needed
|
|
||||||
uses: EndBug/add-and-commit@v9
|
|
||||||
with:
|
|
||||||
message: "GitHub bot : README updated"
|
|
||||||
default_author: github_actions
|
|
||||||
|
|||||||
Reference in New Issue
Block a user