From 245620d4a7e19a3f4acc547c34f0e0d5730cb242 Mon Sep 17 00:00:00 2001 From: angel Date: Sun, 25 Jan 2026 01:30:56 +0000 Subject: [PATCH] docs: add CHANGELOG and commit rewriting script --- CHANGELOG.md | 45 +++++++++++++++++++++++++++++ docs/rewrite-commits.sh | 63 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 108 insertions(+) create mode 100644 CHANGELOG.md create mode 100755 docs/rewrite-commits.sh diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..334002a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,45 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +## [Unreleased] + +### Features +- Fix menubar, add lazy loading, improve image quality, limit search results, filter browse artists +- Add pagination to library/songs and remove listening streaks +- Improve SortableQueueItem component with enhanced click handling and styling +- Add keyboard shortcuts and queue management features +- Add ListeningStreakCard component for tracking listening streaks +- Enhance OfflineManagement component with improved card styling and layout +- Implement Auto-Tagging Settings and MusicBrainz integration +- Enhance audio settings with ReplayGain, crossfade, and equalizer presets; add AudioSettingsDialog component +- Update cover art retrieval to use higher resolution images and enhance download manager with new features +- Enhance UI with Framer Motion animations for album artwork and artist icons +- Add page transition animations and notification settings for audio playback +- Implement offline library synchronization with IndexedDB +- Implement offline library management with IndexedDB support + +### Bug Fixes +- Use git commit SHA for versioning, fix audio playback resume, remove all streak localStorage code +- Docker startup issue, add GitHub release workflow and changelog config + +### Refactoring +- Simplify service worker by removing offline download functionality +- Remove all offline download and caching functionality +- Move service worker registration to a dedicated component for improved client-side handling +- Refactor service worker registration and enhance offline download manager with client-side checks + +### Miscellaneous +- Organize documentation: move markdown files to docs/ folder +- Update version to 2026.01.24 and add changelog for January 2026 release +- Update pnpm-lock.yaml to match new overrides configuration +- Remove PostHog analytics and update dependencies to latest minor versions +- Bump the dev group across 1 directory with 2 updates +- Merge pull request #39 from sillyangel/dependabot/npm_and_yarn/dev-99ea30e4b7 + +### Styling +- Update README formatting and improve content clarity + +## [2026.01.24] - 2026-01-24 + +Previous release before changelog tracking. diff --git a/docs/rewrite-commits.sh b/docs/rewrite-commits.sh new file mode 100755 index 0000000..b6ab229 --- /dev/null +++ b/docs/rewrite-commits.sh @@ -0,0 +1,63 @@ +#!/bin/bash +# Script to rewrite commits to conventional commit format +# WARNING: This rewrites git history. Only use on branches that haven't been shared or after coordinating with team. + +# This script uses git filter-branch to rewrite commit messages +# Run from repository root: bash docs/rewrite-commits.sh + +echo "⚠️ WARNING: This will rewrite git history!" +echo "This should only be done on the offline-support branch before merging to main." +echo "" +read -p "Are you sure you want to continue? (yes/no): " confirm + +if [ "$confirm" != "yes" ]; then + echo "Aborted." + exit 1 +fi + +# Backup current branch +git branch backup-$(date +%Y%m%d-%H%M%S) + +# Set up commit message mapping +export FILTER_BRANCH_SQUELCH_WARNING=1 + +git filter-branch -f --msg-filter ' + msg=$(cat) + + # Skip if already has conventional commit prefix + if echo "$msg" | grep -qE "^(feat|fix|chore|docs|style|refactor|perf|test|build|ci):"; then + echo "$msg" + # Convert specific commit messages + elif echo "$msg" | grep -q "Use git commit SHA for versioning"; then + echo "fix: use git commit SHA for versioning, fix audio playback resume, remove all streak localStorage code" + elif echo "$msg" | grep -q "Fix menubar, add lazy loading"; then + echo "feat: fix menubar, add lazy loading, improve image quality, limit search results, filter browse artists" + elif echo "$msg" | grep -q "Add pagination to library/songs"; then + echo "feat: add pagination to library/songs and remove listening streaks" + elif echo "$msg" | grep -q "Organize documentation"; then + echo "chore: organize documentation - move markdown files to docs/ folder" + elif echo "$msg" | grep -q "Simplify service worker"; then + echo "refactor: simplify service worker by removing offline download functionality" + elif echo "$msg" | grep -q "Remove all offline download"; then + echo "refactor: remove all offline download and caching functionality" + elif echo "$msg" | grep -q "Update pnpm-lock.yaml"; then + echo "chore: update pnpm-lock.yaml to match new overrides configuration" + elif echo "$msg" | grep -q "Remove PostHog analytics"; then + echo "chore: remove PostHog analytics and update dependencies to latest minor versions" + elif echo "$msg" | grep -q "Merge pull request"; then + echo "chore: $(echo "$msg" | sed "s/^Merge/merge/")" + # Default: add chore: prefix to any other commit + else + first_char=$(echo "$msg" | cut -c1 | tr "[:upper:]" "[:lower:]") + rest=$(echo "$msg" | cut -c2-) + echo "chore: ${first_char}${rest}" + fi +' 2025.07.31..HEAD + +echo "" +echo "✅ Commits have been rewritten!" +echo "⚠️ To update the remote branch, you'll need to force push:" +echo " git push origin offline-support --force-with-lease" +echo "" +echo "If something went wrong, restore from backup:" +echo " git reset --hard backup-TIMESTAMP"