Skip to content

docs: describe what the publish smoke test actually imports - #73

Merged
dmccoystephenson merged 2 commits into
mainfrom
docs/releasing-smoke-test-scope
Nov 13, 2026
Merged

dmccoystephenson merged 2 commits into
mainfrom
docs/releasing-smoke-test-scope

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

This is a Stage A (documentation accuracy) cycle. No tracking issue exists for the doc wording itself; the gap was found during the sweep and is related to, but does not close, #46.

Skipped issues

All open issues were deferred this cycle:

Test plan

  • Each claim checked against publish.yml (smoke-test step) and src/main/python/preponderous/graphik/__init__.py (lazy __getattr__, imports only _version).
  • CI Test workflow green on this PR. Only Markdown is changed, so no code path is affected. Local pytest could not be run in this session's sandbox, so the result is recorded as UNVERIFIED-not-applicable.

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

dmccoystephenson and others added 2 commits November 12, 2026 22:24
RELEASING.md called the wheel smoke test a "canonical import", but it
only imports the package, whose lazy __getattr__ never loads graphik.py
or pygame. State the narrower check and point at #46.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Use an em dash like the rest of RELEASING.md, and name what a passing
wheel could still be missing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric (scored against the diff and CI run 43371860193):

  • Scope: PASS. Only RELEASING.md is modified, one bullet, and it is the drift named in the PR body.
  • Tests-new: N/A. No public method was added or changed.
  • Tests-fix: N/A. Documentation only, so there is no code fix to stash and revert.
  • Sibling structure: PASS. The bullet stays in the step-4 list, and the prose follows the file's em-dash style (fixed in the second commit after an ASCII -- was found in the first).
  • Sibling renames: N/A. Nothing was renamed.
  • Docs: PASS. Each claim was checked against .github/workflows/publish.yml (the smoke step runs only import preponderous.graphik plus an __version__ assertion) and against src/main/python/preponderous/graphik/__init__.py (it imports only _version and resolves Graphik through __getattr__). README makes no claim about the publish smoke test, so it needs no change.
  • Issue resolution: PASS. No Closes line is used. release: publish.yml's wheel smoke test never imports Graphik, so a wheel missing graphik.py would still publish #46 tracks the workflow fix and is correctly left open.
  • Manual validation: PASS on CI. Compile and test is green on 3.9 through 3.13 at head 7dd7009. Local pytest could not be run in the session sandbox. With only Markdown changed, that is UNVERIFIED-not-applicable.
  • camelCase / Backward-compat / Headless / Version sync / No new deps: N/A. No source, version, or dependency changes.
  • Do-not-auto-merge paths: none touched (no .github/workflows/*, pyproject.toml, _version.py, or LICENSE changes).

Finding outside the diff, noted only: the README license block reads "Copyright © 2022–2025", while LICENSE reads "Copyright (c) 2025". LICENSE is human-review-only, so that is left for a maintainer.

This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 1b11f20 into main Nov 13, 2026
5 checks passed
@dmccoystephenson
dmccoystephenson deleted the docs/releasing-smoke-test-scope branch November 13, 2026 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant