Skip to content

emrg: document gen-assets.sh for local packaging (post-#688 host symmetry) - #690

Merged
argszero merged 1 commit into
masterfrom
feature/gen-assets-doc-note
Aug 11, 2026
Merged

emrg: document gen-assets.sh for local packaging (post-#688 host symmetry)#690
argszero merged 1 commit into
masterfrom
feature/gen-assets-doc-note

Conversation

@argszero

Copy link
Copy Markdown
Owner

Documentation follow-up to #688 (icon finalization).

Why

#688 made generated icon products (icon.png/icon-512/icon-256/icon.icns/icon.ico) gitignored — the repo keeps only packaging/assets/icon.svg (design source), and CI generates the products at build time. But local installer builds (make-installer.sh / build-runtime.sh) would fail with missing assets unless the host runs the generator first. No doc mentioned this (flagged as non-blocking in the #688 review).

Changes

  • DEVELOPMENT.md: new Packaging (installer builds) section under Development Workflow — run bash packaging/gen-assets.sh before local installer builds; documents idempotency, renderer priority (rsvg-convert → Chrome/Chromium headless → sips), and macOS-only iconutil for .icns
  • Agent.md: Packaging section under Test Commands with the same note

Mirrors the #467/#468 host-symmetry principle: CI validates the path, host has a documented self-check so it succeeds on the first attempt.

Verification

  • pytest 694 passed · doc-count guard 3 passed · import + --help OK (docs-only change)

…etry)

#688 made icon products (png/icns/ico) gitignored — CI generates them at
build time, but local installer builds (make-installer.sh / build-runtime.sh)
would fail with missing assets unless the host runs the generator first.

- DEVELOPMENT.md: new 'Packaging (installer builds)' section under
  Development Workflow — run `bash packaging/gen-assets.sh` first
  (idempotent; renderer priority rsvg-convert → Chrome headless → sips;
  .icns needs macOS iconutil, skipped elsewhere)
- Agent.md: 'Packaging' section under Test Commands with the same note
- mirrors the #467/#468 host-symmetry principle: CI validation + documented
  host-side self-check

@argszero argszero left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM — cycle (1st)

Docs-only change (Agent.md + DEVELOPMENT.md): Packaging section documents running bash packaging/gen-assets.sh before local installer builds (icon products gitignored since #688). Verified: pytest 694 + doc-count guard 3 pass (no test counts touched), import + --help OK, CI Test green (31484828892). Addresses the #688 review's non-blocking note + #467/#468 host-symmetry principle.

@argszero argszero left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM — cycle

Verified:

  • Doc-only change (Agent.md + DEVELOPMENT.md) documenting that icon products are gitignored and local installer builds must run bash packaging/gen-assets.sh first — correct host-symmetry follow-up to #688 (#467/#468 principle: CI validation + documented host-side self-check)
  • Content matches actual gen-assets.sh behavior (renderer priority rsvg-convert → Chrome headless → sips; iconutil macOS-only, skipped elsewhere)
  • CI test PASS (31484828892)

@argszero argszero left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM — cycle (3rd, different cycle)

Fresh re-verification of head c1f01b4 (unchanged since R828): docs-only (Agent.md + DEVELOPMENT.md Packaging sections); pytest 694 + doc-count guard pass; CI Test green (31484828892). Mergeable — proceeding to merge.

@argszero
argszero merged commit 6b8fff3 into master Aug 11, 2026
1 check passed

@argszero argszero left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM — cycle (3rd)

Fresh re-verification on head c1f01b4 (unchanged):

  • Doc-only change (Agent.md + DEVELOPMENT.md) — Packaging section documents running bash packaging/gen-assets.sh before local installer builds, since icon products are gitignored (#688); renderer priority and macOS-only iconutil accurately described
  • Correct host-symmetry follow-up (#467/#468: CI generates at build time, host self-check documented)
  • Local: pytest 694 ✓ import ✓ --help ✓; CI Test PASS (31484828892)

Mergeable.

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