From fcd038c562d419738ef14847cb6b44d505c66796 Mon Sep 17 00:00:00 2001 From: RNL Date: Wed, 12 Aug 2026 22:25:17 +1000 Subject: [PATCH] ci(readme): auto-generate release notes on tag, add dashboard tour to README - bump-version.yml now creates a GitHub Release with `--generate-notes` alongside each version tag, so the Tags/Releases page is self-describing instead of a bare list of vX.Y.Z tags with no context. - README gets a Dashboard Tour gallery using the wiki's existing user-attachments image URLs (no binary images added to the repo). --- .github/workflows/bump-version.yml | 13 ++++++++++++ README.md | 34 ++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml index d270058..07cd11c 100644 --- a/.github/workflows/bump-version.yml +++ b/.github/workflows/bump-version.yml @@ -5,6 +5,10 @@ on: branches: - main +concurrency: + group: bump-version-main + cancel-in-progress: false + jobs: bump-version: runs-on: ubuntu-latest @@ -49,8 +53,17 @@ jobs: git config user.email "github-actions[bot]@users.noreply.github.com" git add pyproject.toml git commit -m "chore: bump version to ${{ steps.bump.outputs.new_version }} [skip ci]" + git pull --rebase origin main git push - name: Tag the release run: | git tag "v${{ steps.bump.outputs.new_version }}" git push origin "v${{ steps.bump.outputs.new_version }}" + + - name: Create GitHub release with auto-generated notes + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + gh release create "v${{ steps.bump.outputs.new_version }}" \ + --title "v${{ steps.bump.outputs.new_version }}" \ + --generate-notes diff --git a/README.md b/README.md index b3bb905..a7dbb3a 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,42 @@ It runs quietly in the background 24/7, capturing every print, filament change, --- +## What It Looks Like + + + + + + + + + + + + + +
+

Live Dashboard
Real-time nozzle temps, bed temp, print progress, and chamber light.

+ Live Dashboard + 		+

Historical Charts
Filament remaining and nozzle temp over time, per printer.

+ Historical Charts +
+

Filament Inventory
Every spool you own — brand, type, color, remaining %, current tray.

+ Filament Inventory + 		+

AMS / Filament Slots
What's loaded right now, grouped by AMS unit, with humidity/temp.

+ AMS / Filament Slots +
+

Hotend Wear Tracking
Used time and wear per hotend slot — handy for multi-nozzle / AMS-fed toolhead setups.

+ Hotend Wear Tracking +
+ +--- + ## Table of Contents +- [What It Looks Like](#what-it-looks-like) - [Native Setup (Recommended for Raspberry Pi)](#native-setup-recommended-for-raspberry-pi) - [What You'll Need](#what-youll-need) - [Clone and run setup.sh](#clone-and-run-setupsh)