From a0c3dd06e00518c5f6e997883cd9f1e2ccbec1ad Mon Sep 17 00:00:00 2001 From: ArcueidMP <263883869+ArcueidMP@users.noreply.github.com> Date: Thu, 21 May 2026 21:46:00 +0800 Subject: [PATCH] docs: add v0.1 release readiness notes --- README.md | 12 ++-- docs/dev-log.md | 31 ++++++++-- docs/release-readiness.md | 120 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 152 insertions(+), 11 deletions(-) create mode 100644 docs/release-readiness.md diff --git a/README.md b/README.md index 788204c..a4386ce 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,10 @@ The repository now includes a basic MVP for the transparent-PNG flow: - transparent, draggable, always-on-top Runtime window with a minimal context menu -This is still not release-ready. Stage 9 should do an end-to-end smoke pass, -source-of-truth consistency check, minimal CI consideration, and release -readiness notes before any v0.1 release decision. +AutoPet is still not a v0.1 release. Stage 9.2 manual E2E smoke has passed, +Stage 9.3 minimal non-GUI Windows CI exists, and Stage 9.4 release-decision +readiness notes summarize evidence for a human release decision. No tag, +release, installer, binary, or artifact has been created. The first implementation target is Windows 10/11, developed with the Windows Codex App workflow in mind. The architecture should avoid unnecessary @@ -469,8 +470,9 @@ checks and the Python image-pipeline compile/test checks. CI does not replace the manual Stage 9 E2E smoke checklist. It does not launch the Electron GUI apps or build release installers. -AutoPet is still not a v0.1 release yet. Release-readiness notes are still -pending. +AutoPet is still not a v0.1 release yet. Release-decision readiness notes live +in `docs/release-readiness.md`. That document is not release instructions and +does not imply installers or GitHub Release binaries exist. --- diff --git a/docs/dev-log.md b/docs/dev-log.md index de28b09..91e1486 100644 --- a/docs/dev-log.md +++ b/docs/dev-log.md @@ -31,7 +31,9 @@ Current handoff state: Stage 8 is complete. Stage 9.1 added the manual E2E smoke checklist and source-of-truth cleanup. Stage 9.2 manual E2E smoke passed on 2026-05-21. -Stage 9.3 is the current minimal CI workflow task. +Stage 9.3 added the minimal non-GUI Windows CI workflow and was merged in +PR #18. +Stage 9.4 is the current v0.1 release-decision readiness notes task. ``` Known merged pull requests documented in this log: @@ -54,6 +56,7 @@ PR #14: Add Maker image pipeline runner helper PR #15: Export pet packages from transparent PNGs PR #16: Refresh source of truth after Stage 8 PR #17: Add Stage 9 E2E smoke checklist +PR #18: Add Stage 9 validation workflow ``` Completed / current stages: @@ -74,7 +77,8 @@ Completed / current stages: - Stage 8.2: Maker transparent PNG export UI / IPC integration. - Stage 9.1: Manual v0.1 E2E smoke checklist and source-of-truth cleanup. - Stage 9.2: Manual Maker export to Runtime `Load Pet...` E2E smoke passed. -- Stage 9.3: Minimal non-GUI Windows CI workflow task is current. +- Stage 9.3: Minimal non-GUI Windows CI workflow. +- Stage 9.4: v0.1 release-decision readiness notes. Latest known verification: @@ -123,6 +127,16 @@ No bugfix PR was needed from the smoke run. Final git status --short was clean, and the temporary branch test/stage9-e2e-smoke-run was deleted. ``` +Stage 9.3 minimal CI was merged through PR #18: + +```text +PR #18: ci: add stage 9 validation workflow +Merge commit: 7e4bd77 +Workflow: Windows non-GUI baseline validation +pull_request CI run: green +main push CI run for 7e4bd77: green +``` + Current source-of-truth files for future ChatGPT / Codex threads: ```text @@ -130,6 +144,7 @@ README.md AGENTS.md docs/dev-log.md docs/pet-schema.md +docs/release-readiness.md docs/workflows/codex-pr-workflow.md docs/workflows/v0.1-e2e-smoke-checklist.md ``` @@ -137,8 +152,9 @@ docs/workflows/v0.1-e2e-smoke-checklist.md Current recommended next task: ```text -Open the Stage 9.3 minimal CI PR and confirm the GitHub Actions run is green. -Then proceed to release-readiness notes. +Review the release-readiness notes. +Make a human v0.1 release decision. +Do not tag or publish a release unless explicitly requested by the human. ``` Stage 9 should not assume installer creation, GitHub Release binaries, release @@ -1007,8 +1023,9 @@ This cleanup should be kept separate from feature work. Recommended next task: ```text -Open the Stage 9.3 minimal CI PR and confirm the GitHub Actions run is green. -Then proceed to release-readiness notes. +Review the release-readiness notes. +Make a human v0.1 release decision. +Do not tag or publish a release unless explicitly requested by the human. ``` Stage 9.1 checklist path: @@ -1036,7 +1053,9 @@ README.md AGENTS.md docs/dev-log.md docs/pet-schema.md +docs/release-readiness.md docs/workflows/codex-pr-workflow.md +docs/workflows/v0.1-e2e-smoke-checklist.md ``` Each Codex thread should handle only one small task. diff --git a/docs/release-readiness.md b/docs/release-readiness.md new file mode 100644 index 0000000..91ff69e --- /dev/null +++ b/docs/release-readiness.md @@ -0,0 +1,120 @@ +# v0.1 Release Readiness Notes + +## Status + +- AutoPet is not a v0.1 release yet. +- These notes summarize readiness for a human v0.1 release decision. +- This document does not create a tag, release, installer, binary, or artifact. + +## Current v0.1 Implemented Baseline + +- Maker transparent PNG selection. +- Maker output folder selection. +- Maker local Python image pipeline invocation. +- Generated pet package folder containing `pet.json`, `spritesheet.png`, and + `preview.gif`. +- Runtime `Load Pet...` local folder support. +- Runtime manifest validation and sprite display. +- Runtime transparent draggable always-on-top window. +- Runtime right-click menu with `Load Pet...`, `Reset Position`, + `Always on Top`, and `Exit`. + +## Evidence + +Stage 9.2 manual E2E smoke passed on 2026-05-21. + +Environment: + +- Branch: `test/stage9-e2e-smoke-run` +- Commit: `6bf3eeb` +- Node: `v24.15.0` +- pnpm: `10.33.4` +- Python: `3.13.13` + +Local baseline commands passed: + +```powershell +git diff --check +corepack pnpm typecheck +corepack pnpm build +corepack pnpm --filter @autopet/image-pipeline typecheck +corepack pnpm --filter @autopet/image-pipeline test +.\.venv\Scripts\python.exe -m compileall packages\image-pipeline\autopet_image_pipeline +.\.venv\Scripts\python.exe -m unittest discover -s packages\image-pipeline +``` + +The pnpm image-pipeline test and Python unittest suite each reported 4 tests +OK. + +The manual Maker export -> generated package -> Runtime `Load Pet...` path +passed. Maker exported a transparent PNG package outside the repository under +`%TEMP%\autopet-v0.1-e2e-smoke`; the generated package contained `pet.json`, +`spritesheet.png`, and `preview.gif`; and `pet.json` referenced +`spritesheet.png`. + +Runtime launch, right-click menu, `Load Pet...`, generated pet display, visible +animation advancement, drag, `Reset Position`, `Always on Top` toggle, and +`Exit` passed by human manual confirmation. + +No bugfix PR was needed from the smoke run. + +Stage 9.3 minimal CI: + +- PR #18: `ci: add stage 9 validation workflow` +- Merge commit: `7e4bd77` +- Scope: Windows non-GUI baseline validation. +- `pull_request` CI run: green. +- `main` push CI run for `7e4bd77`: green. + +## CI Scope + +- CI validates non-GUI baseline checks on Windows. +- CI runs TypeScript typecheck/build checks. +- CI runs Python image-pipeline compile/test checks. +- CI does not launch Maker or Runtime. +- CI does not perform manual GUI smoke. +- CI does not build installers or release artifacts. + +## Known Limitations / Explicit Non-Goals + +- No installer. +- No GitHub Release binary. +- No release publishing. +- No auto-updater. +- No zip export. +- No persistent settings. +- No Runtime launch-from-Maker. +- No `rembg`. +- No cloud APIs. +- No system tray. +- No multi-pet support. +- No plugin system. +- No blinking. +- No waving. +- No walking. +- No talking. +- No skeleton rigging. +- No Live2D. +- No image-to-video. +- No complex CV. + +## Release Decision Checklist + +- [x] Source-of-truth docs updated through Stage 9.3. +- [x] Manual Stage 9.2 E2E smoke passed. +- [x] Minimal Stage 9.3 CI workflow exists. +- [x] CI run status recorded accurately. +- [x] Known limitations documented. +- [ ] Human still needs to decide whether to tag v0.1. +- [ ] Human still needs to decide whether any release artifact is required. +- [x] No release action has been performed by this PR. + +## Recommended Next Decision + +If the human accepts the current v0.1 baseline, the next step is a human release +decision. + +If the human wants more assurance first, rerun the manual E2E smoke checklist +from `docs/workflows/v0.1-e2e-smoke-checklist.md`. + +Do not add new features before the release decision.