Skip to content

docs: separate release publication from print verification #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CrimsonSoul merged 1 commit into from
Sep 5, 2026
Merged

docs: separate release publication from print verification #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 7 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,12 @@ printer. Approved UI references live in `.impeccable/`.
- Finish with only local `main`, zero divergence from `origin/main`, and the
temporary remote PR branch deleted after confirmed merge. Verify each merged
`main` push produces its Windows artifact.
- Releases additionally require completed Windows smoke evidence, a committed
version bump in `src/__init__.py` (the sole version source), and explicit
- Releases additionally require successful packaged Windows startup evidence
for the exact merged commit, a committed version bump in `src/__init__.py`
(the sole version source), and explicit
user authorization for a Build dispatch on `main` with `create_release`
enabled. Never hand-enter a separate workflow version or dispatch a release
from an unverified/uncommitted version.
from an unverified/uncommitted version. Word/physical-printer testing is
separate: complete the Windows checklist before claiming print verification.
Its unavailability does not block publication, but must be disclosed in the
release notes. Known printing failures still block release.
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,10 @@ ambiguous templates block preflight. Failed documents receive CSV reports.

Install `requirements-dev.txt` for development. [AGENTS.md](AGENTS.md) owns
verification commands and protected publication/release rules. Non-Windows
tests mock Windows dependencies; real Word COM and physical printing require
the [Windows smoke test](docs/windows-smoke-test.md) before release.
tests mock Windows dependencies. Packaged Windows startup is required for
release; real Word COM and physical printing remain unverified until the
[Windows smoke test](docs/windows-smoke-test.md) passes. Release notes disclose
any unavailable physical-print validation.

Each merged `main` push produces a PyInstaller executable artifact named
`ShiftPress-v<version>-<commit>`, retained for seven days. Release versions come
Expand Down
10 changes: 6 additions & 4 deletions docs/windows-smoke-test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Windows Print Smoke Test

Before release, run this checklist on Windows with Microsoft Word, the intended
physical printer, representative Day/Night template folders, and the release
candidate executable (or Python 3.12 via `start_app.bat`). Automated tests and
packaged startup checks do not establish physical printing.
To verify real printing, run this checklist on Windows with Microsoft Word,
the intended physical printer, representative Day/Night template folders, and
the release candidate executable (or Python 3.12 via `start_app.bat` for source
testing). Automated tests and packaged startup checks do not establish physical
printing. [AGENTS.md](../AGENTS.md) owns the separate publication requirements;
record unavailable print validation honestly rather than treating it as passed.

## Preparation

Expand Down