Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,21 @@ jobs:
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
# The test suite imports pdfreader_lib.mcp_server, which needs the
# optional MCP SDK to define its tool list at import time.
python -m pip install -r requirements-mcp.txt
python -m pip install pytest

- name: Compile-check Python sources
run: |
python -m compileall . -q

- name: Run regression test suite
env:
QT_QPA_PLATFORM: offscreen
run: |
python -m pytest tests/ -q

- name: Run update detection regression tests
run: |
python tools/test_updater_asset_flow.py
Expand Down
26 changes: 17 additions & 9 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ on:
push:
tags:
- "v*.*.*"
# Two-phase release: a tag push builds and uploads the artifacts only.
# After the artifacts and version metadata are verified, publish explicitly:
# gh workflow run release.yml --ref vX.Y.Z -f publish=true
workflow_dispatch:
inputs:
publish:
description: "Publish the GitHub release (only after artifacts are verified)"
type: boolean
default: false

permissions:
contents: write
Expand Down Expand Up @@ -100,9 +109,7 @@ jobs:
}

if (-not $makeAppx) {
Write-Host "MakeAppx.exe not found — skipping MSIX build."
Write-Host "Install Windows SDK or Visual Studio Build Tools for MSIX support."
exit 0
throw "MakeAppx.exe not found — the MSIX package is required for a release."
}

# Normalize MakeAppx path
Expand Down Expand Up @@ -287,6 +294,7 @@ jobs:

publish:
name: Publish GitHub Release
if: github.event_name == 'workflow_dispatch' && inputs.publish == true
runs-on: ubuntu-latest
needs:
- build-windows
Expand All @@ -308,12 +316,12 @@ jobs:
test -f "release-assets/OpenReader-Setup.exe" || { echo "Missing Windows Setup.exe"; exit 1; }
test -f "release-assets/OpenReader-macOS-Apple-Silicon.zip" || { echo "Missing macOS Apple Silicon ZIP"; exit 1; }
test -f "release-assets/OpenReader-macOS-Intel.zip" || { echo "Missing macOS Intel ZIP"; exit 1; }
# MSIX is optional until signing is set up; warn if missing
if [ -f "release-assets/OpenReader.msix" ]; then
echo "MSIX package found — will attach to release"
else
echo "⚠️ MSIX package not found — MakeAppx.exe may not be available on this runner"
fi
# The Store package is mandatory for a release.
test -f "release-assets/OpenReader.msix" || {
echo "Missing OpenReader.msix — the Store package is required for a release."
exit 1
}
echo "MSIX package verified"
echo "All required assets verified"

- name: Generate release notes
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This repository is a local-first desktop PDF utility. Keep maintenance changes b

## Product Boundaries

**Current version:** v1.2.7 (2026-08-02) — Store-aware updates, default-reader UX, Windows file associations
**Current version:** v1.2.8 (2026-11-08) — virtualized continuous scrolling and the unified Fluent toolbar

- Do not add new user-facing PDF features unless the task explicitly asks for them.
- Do not change the local-first privacy philosophy.
Expand Down
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Changelog

## v1.2.8 — Continuous Reading & Toolbar Redesign — 2026-11-08

- **Fixed (continuous scrolling):** The continuous view no longer renders a sliding window around the current page. Every page now gets a correctly sized placeholder in one persistent document layout, so the scrollbar spans the whole PDF — a 76-page document exposes all 76 pages instead of roughly six. Pixmaps are rendered lazily for the viewport plus a small overscan and released once they leave the cache window, so memory stays bounded for very long documents.
- **Fixed (navigation):** Next/Previous, the page box, search results, and semantic-search jumps scroll directly to the target page without rebuilding the layout or discarding pages already scrolled past. Scrolling updates the page indicator, zoom changes preserve the reader's position, and small and large documents behave identically.
- **Fixed:** Removed a `NameError: name '_t' is not defined` at the end of `_render_continuous` that fired on every continuous render in v1.2.7.
- **Changed (toolbar):** Replaced the two stacked control rows and Windows 98-era styling with a single 44 px Fluent-style command bar. File, page, zoom, annotation, and search actions are grouped and separated; icons are vector-drawn at a consistent 18 px inside 32 px targets; the zoom percentage is shown live; the page control is a compact `N / total` counter; and search is an integrated field with previous/next match controls and a semantic toggle.
- **Changed (themes):** Rewrote the light and dark stylesheets around a shared neutral palette with the OpenReader accent — pill tabs, hairline separators, themed scrollbars, menus, status bar, and empty state. Toolbar icons and the empty-state glyph are regenerated when the theme changes.
- **Fixed (tabs):** Switching tabs now refreshes the page counter and page-box range to the newly active document. The tab strip hides when no documents are open.
- **Accessibility:** Every icon-only toolbar button has an accessible name and a tooltip; all existing keyboard shortcuts are unchanged.
- **Verification:** New continuous-scrolling regression suite (full-document range, scroll indicator, navigation persistence, jump-to-page, zoom retention, virtualization, small documents) and toolbar/UI suite (icon consistency, theme recoloring, shortcuts, navigation, zoom, annotations, search, multi-tab, mode toggle). Full suite: 160 passed, 18 skipped.

## v1.2.5 — File Association & Branding — 2026-08-02

- **Version:** Bumped `__version__` to `1.2.5`, MSIX version to `1.2.5.0`; aligned the MCP package, packaging manifests, and release configuration to a single version source. `scripts/inject_version.py` now propagates the version to `main.py`, `packages/mcp-server/pyproject.toml`, and both MSIX manifests.
Expand Down
3 changes: 2 additions & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

**Latest update:** v1.2.7 — Store-aware updates, default-reader UX, Windows file associations (2026-08-02)
**Latest update:** v1.2.8 — virtualized continuous scrolling, unified Fluent toolbar, light/dark redesign (2026-11-08)

Privacy-first, local-only desktop PDF utility for Windows.
macOS experimental; Linux unsupported.
Expand All @@ -11,6 +11,7 @@ macOS experimental; Linux unsupported.

| Version | Date | Summary |
|---------|------|---------|
| v1.2.8 | 2026-11-08 | Continuous scrolling rebuilt as a virtualized full-document layout; unified 44 px Fluent toolbar with vector icons; light/dark chrome redesign; tab page-controls fix |
| v1.2.7 | 2026-08-02 | Store-aware updates — install-source detection, channel-aware Software Updates dialog, persisted skip + last-checked |
| v1.2.6 | 2026-08-02 | Default Reader Experience — Windows UserChoice detection, Settings dialog, first-launch default prompt |
| v1.2.5 | 2026-08-02 | Windows File Association Fix — MSIX `.pdf` association, ChangesAssociations, single-source version injector, changelog cleanup |
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ The focus is on reading and working with documents, not fighting the interface.

| Release | Date | Milestone |
|---------|------|-----------|
| **v1.2.8** | Nov 2026 | Continuous scrolling rebuilt on a virtualized full-document layout; unified Fluent toolbar and light/dark redesign |
| **v1.2.7** | Aug 2026 | Store-aware updates — install-source detection, channel-aware update dialog |
| **v1.2.6** | Aug 2026 | Default reader experience — Windows default-app detection and settings |
| **v1.2.5** | Aug 2026 | Windows file association (`windows.fileTypeAssociation`) and single-source versioning |
| **v1.2.4** | Jun 2026 | Toolbar icon redesign — all buttons use QPainter vector icons |
| **v1.2.3** | Jun 2026 | Reader UX polish — Fit Page on open, Ctrl+Mouse Wheel zoom |
| **v1.2.2** | Jun 2026 | Store submission fix — XML DOM patching, CI validation |
Expand Down
4 changes: 3 additions & 1 deletion docs/Architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ OpenReader is a local-first desktop PDF utility built with Python and PySide6 (Q

| Component | Module | Purpose |
|-----------|--------|---------|
| GUI | `main.py` | PySide6 application window, menus, controls bar, PDF viewer |
| GUI | `main.py` | PySide6 application window, menus, unified toolbar, PDF viewer |
| PDF Engine | — | PyMuPDF (MuPDF bindings) for rendering, text extraction, annotation |
| Search | `pdfreader_lib/search_index.py` | SQLite FTS5 keyword index + TF-IDF semantic search |
| Comparison | `pdfreader_lib/comparison.py` | Page-by-page text diff with color-coded output |
Expand All @@ -47,6 +47,8 @@ OpenReader is a local-first desktop PDF utility built with Python and PySide6 (Q
3. **SQLite for indexing.** Library search uses SQLite FTS5 (keyword) and scikit-learn TF-IDF (semantic). Both are local, zero-configuration, and fast.
4. **MCP server as library.** The MCP server is built into `pdfreader_lib/` and can be used standalone or alongside the GUI. It shares the same underlying search and comparison modules.
5. **No self-update.** The app detects updates via GitHub API but never downloads or runs installers. MSIX updates are handled by Windows App Installer.
6. **Virtualized continuous rendering.** The default view keeps one correctly sized placeholder widget per page in a single persistent layout, so the scrollbar always spans the whole document and every page stays reachable. Page pixmaps are rendered lazily for the viewport plus a small overscan (`CONTINUOUS_OVERSCAN`) and released once they leave the cache window (`CONTINUOUS_CACHE`), keeping memory bounded at high zoom and for long documents. Scroll position drives the current page; Next/Previous, the page box, and search jumps scroll in place without rebuilding the layout. Explicit renders (zoom, annotations, search, theme) invalidate the cached pixmaps. Single-page mode remains available via **View → Continuous Scroll**.
7. **Theme-aware design system.** A single 44 px toolbar groups file, page, zoom, annotation, and search actions. Icons are drawn as vectors from one factory (`_make_toolbar_icon`) in the active theme's palette, and both light and dark stylesheets share the same neutral tokens with the OpenReader accent.

## Security Model

Expand Down
18 changes: 12 additions & 6 deletions docs/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,22 @@ no separate code-signing certificate is needed.
1. Make sure `main` is green in GitHub Actions.
2. Update `CHANGELOG.md`.
3. Commit all release notes/docs changes.
4. Create and push a semantic version tag:
4. Create and push an **annotated** semantic version tag:

```bash
git tag v1.2.2
git push origin v1.2.2
git tag -a v1.2.8 -m "OpenReader v1.2.8"
git push origin v1.2.8
```

5. GitHub Actions runs `.github/workflows/release.yml`.
6. The workflow builds Windows (MSIX + Setup.exe + ZIP), macOS Apple Silicon, and macOS Intel packages.
7. The workflow creates the GitHub Release and attaches all assets.
5. Pushing the tag runs `.github/workflows/release.yml` in **build-only** mode. The workflow builds and uploads Windows (MSIX + Setup.exe + ZIP), macOS Apple Silicon, and macOS Intel packages as workflow artifacts; it does **not** create the GitHub Release.
6. Verify the artifacts on the tag run: `OpenReader.msix` identity/version, `OpenReader-Setup.exe`, and the ZIPs. The MSIX is mandatory — the workflow fails if `MakeAppx.exe` is unavailable or the MSIX is missing.
7. Publish explicitly from the verified tag:

```bash
gh workflow run release.yml --ref vX.Y.Z -f publish=true
```

The manual run rebuilds the packages and its `publish` job creates the GitHub Release with every artifact attached.

## Update Detection

Expand Down
21 changes: 18 additions & 3 deletions docs/store-acceptance-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The MSIX package cannot be produced or signed locally: production signing uses
the Microsoft Store identity (no self-procured code-signing certificate), and
the Windows SDK `MakeAppx.exe`/Store signing pipeline runs in Partner Center.
This checklist covers the Store-specific validation that must happen **after**
the `v1.2.7` MSIX is submitted and signed by the Store.
the `v1.2.8` MSIX is submitted and signed by the Store.

Frozen identity (do not alter):
| Field | Value |
Expand All @@ -16,7 +16,7 @@ Frozen identity (do not alter):

## On a clean Windows machine, after Store install

- [ ] Install from the Microsoft Store; app launches and reports **v1.2.7** (Help → About).
- [ ] Install from the Microsoft Store; app launches and reports **v1.2.8** (Help → About).
- [ ] `Get-AppxPackage` shows the package with the frozen identity and PFN.
- [ ] The process runs with a package identity — install-source detection
reports the Store channel (no GitHub request on launch; Help → Check for
Expand All @@ -41,7 +41,22 @@ Frozen identity (do not alter):
- [ ] First-launch prompt: **Set as default** opens Default Apps; **Do not ask
again** persists across launches.

### Updates (v1.2.7)
### Continuous reading & toolbar (v1.2.8)
- [ ] Open a 50+ page PDF; scroll from page 1 to the final page and back
without using navigation. Every page remains reachable and the page
indicator follows the viewport.
- [ ] Next/Previous, the page box, and search-result jumps scroll directly to
the requested page without removing access to other pages.
- [ ] Zoom (`−`/`+`, Fit, Ctrl+mouse-wheel) keeps the reading position and the
live zoom percentage updated.
- [ ] The single toolbar shows file/page/zoom/annotation/search groups; the
search field, match navigation, and zoom percentage fit without overflow
at the default window size.
- [ ] Light and dark themes render the toolbar, tabs, menus, scrollbars, and
empty state correctly.
- [ ] Switching tabs updates the page counter and page range (`/ N`).

### Updates (v1.2.7+)
- [ ] Store install never queries `api.github.com` (silent launch check and
Help → Check for Updates both use the Store channel).
- [ ] **Open Microsoft Store** button opens the Store listing.
Expand Down
Loading
Loading