From b1c421e242a45521848f0821d792f81d8f904dc5 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 5 Oct 2026 23:28:08 +0000 Subject: [PATCH] Publish release notes with update steps on the GitHub release The release workflow now uses docs/releases/.md as the release page (plus the generated change list) and fails early if it is missing. docs/releases/1.1.0.md tells 1.0.x users how to update. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01A59Ve6VGuz6nxXu3QEXpeA --- .github/workflows/release-windows.yml | 9 +++++++++ README.md | 9 +++++---- docs/releases/1.1.0.md | 29 +++++++++++++++++++++++++++ 3 files changed, 43 insertions(+), 4 deletions(-) create mode 100644 docs/releases/1.1.0.md diff --git a/.github/workflows/release-windows.yml b/.github/workflows/release-windows.yml index 33eb6ba..814482a 100644 --- a/.github/workflows/release-windows.yml +++ b/.github/workflows/release-windows.yml @@ -72,10 +72,19 @@ jobs: packaging/Output/AppTrackr_Setup.exe dist/AppTrackr_Portable.zip + - name: Check release notes + if: github.ref_type == 'tag' + shell: pwsh + run: | + $notes = "docs/releases/${{ steps.version.outputs.value }}.md" + if (-not (Test-Path $notes)) { Write-Error "Missing $notes (update steps shown on the release page)"; exit 1 } + - name: Publish release if: github.ref_type == 'tag' uses: softprops/action-gh-release@v2 with: + name: AppTrackr ${{ steps.version.outputs.value }} + body_path: docs/releases/${{ steps.version.outputs.value }}.md files: | packaging/Output/AppTrackr_Setup.exe dist/AppTrackr_Portable.zip diff --git a/README.md b/README.md index 9ba8409..5c65279 100644 --- a/README.md +++ b/README.md @@ -241,16 +241,17 @@ On headless Linux, Qt needs `libegl1` and `libxkbcommon0`, and tests run with `Q ### Releasing -Bump `__version__` in `apptrackr/__init__.py`, then push a matching tag: +Bump `__version__` in `apptrackr/__init__.py`, write the release page text (including how to update) in +`docs/releases/.md`, then push a matching tag: ```bash git tag v1.1.0 git push origin v1.1.0 ``` -`.github/workflows/release-windows.yml` checks that the tag matches the version, runs the tests, builds -the PyInstaller bundle, self-tests it, packages the portable zip and the Inno Setup installer, and attaches -both to the GitHub release. `ci.yml` runs lint and tests on Windows and Linux for every push and pull request. +`.github/workflows/release-windows.yml` checks that the tag matches the version and that the release notes +exist, runs the tests, builds the PyInstaller bundle, self-tests it, packages the portable zip and the Inno +Setup installer, and publishes both with the notes as the GitHub release. `ci.yml` runs lint and tests on Windows and Linux for every push and pull request. ### Project structure diff --git a/docs/releases/1.1.0.md b/docs/releases/1.1.0.md new file mode 100644 index 0000000..7117440 --- /dev/null +++ b/docs/releases/1.1.0.md @@ -0,0 +1,29 @@ +AppTrackr 1.1.0 is a full rework: more accurate tracking, a new interface with six themes, and in-app updates from now on. Your existing history, rewards, village and settings all carry over. + +## How to update + +**If you have AppTrackr 1.0.x** + +1. Download **AppTrackr_Setup.exe** below. +2. Run it. If Windows shows "Windows protected your PC", click **More info**, then **Run anyway**. +3. Click through the installer. It closes the running AppTrackr and replaces it in the same place. +4. AppTrackr starts again with all your data. + +Before converting your data, AppTrackr saves a copy of it as `data-backup-schema0-.sqlite` in `%APPDATA%\AppTrackr`. + +**If you use the portable zip** + +Download **AppTrackr_Portable.zip**, extract it anywhere and run `AppTrackr.exe`. Your data is shared with the installed version, so nothing is lost. + +**After this update** + +AppTrackr checks for new versions once a day. When one is out, open **Settings** and click **Download and install**. + +## What's new + +- Time counts only while an app is in front, stops at your last input when you go idle, and is saved every 30 seconds. Days that 1.0 under-counted (sessions that ended in idle or ran past midnight) are recalculated from your history. +- A new interface: live session dial, calendar heatmap, per-app history, and "In other terms" (your week as Everest summit days, Moon trips or marathons). +- Six themes (Graphite, Carbon, Midnight, Paper, Porcelain, Sage) with eight accent colours. +- Daily limits per app, exclusions with undo, pause for a set time, notifications you can choose by type. +- Rewards and village carry over; claiming and building now have a little celebration. +- CSV and JSON export, backup and restore, start in the tray at sign-in.