Skip to content

[Release] Documentation, regression gates, packaging, signing, and distribution readiness #15

Open

Description

@raiseCatError

Priority: P2 (release readiness, after core quality fixes)
Parent roadmap: #1

Goal

Ship a maintainable, reproducible Tuck build with an honest compatibility story. Personal ad-hoc builds should remain possible; public distribution may require Developer ID signing and notarization.

Deliverables

  • Update README with supported macOS versions/architectures, how to install/uninstall, enable the Finder Sync extension, troubleshoot app URL-handler / helper IPC, and access Settings.
  • Document available action categories, strict decimal-MB limits, non-destructive output naming, optional codec dependencies and known unsupported formats/features.
  • Document dependency choices and associated third-party licenses/attributions; do not bundle or distribute third-party executables without complying with their licenses and signing constraints.
  • Reproducible Swift 6 build and tests for Apple Silicon, with Intel support explicitly tested or documented as unsupported.
  • Ensure optional encoders are discovered predictably (Homebrew/explicit paths) with helpful fallback errors; no silent install/download during use.
  • Ensure build artifacts and large temp/caches go to verified external scratch locations for this developer's workflow; avoid deleting unrelated files, local worktrees or untracked backups.
  • Separate headless unit/IPC/fixture tests from physical Finder/manual GUI verification. Maintain a release checklist for context menus, Settings, previews, permissions, collision handling, cancellation and original hashes.
  • Assess signing/notarization path for future public distribution (entitlements, helper, Finder extension, bundled tools and updater). Do not require a paid Apple account for local personal installation.
  • Review privacy/security story: local-only processing by default, secret/log redaction, file permissions, temporary-file cleanup, no unnecessary network calls, user confirmation for destructive operations.
  • Define version numbering, changelog, release notes and artifact verification (checksums) without publishing anything automatically.

Acceptance criteria

  • Fresh-machine installation steps are understandable and reproducible.
  • Ad-hoc local installation works in ~/Applications.
  • Optional encoder absence yields graceful degradation, not mysterious no-ops.
  • Regression checklist covers current compression fixtures, PDF/image tools, metadata, ZIP, multi-selection and Finder helper IPC.
  • Signing/notarization limitations for public distribution are explicitly documented and investigated.
  • Release build instructions never implicitly push, tag, notarize or publish without approval.

Tests

Repeat installs, updates and uninstalls, user defaults persistence, Finder extension registration, code signature checks, both supported architectures if claimed, and manual GUI QA. Link any remaining blockers to individual issues instead of calling the release ready.

Activity

  1. raiseCatError commented on Oct 16, 2026

    @raiseCatError
    OwnerAuthor

    Documentation progress: #17 replaced stale four-action README with current functionality, limits, optional encoders, installation and verification steps; #19 updated AGENTS.md for current job/ZIP/codec architecture. Both passed macOS CI. Remaining release work: verify distribution licenses, notarization/Developer ID strategy, fresh-machine installation, supported macOS/architectures, physical Finder QA and full privacy/security review. Keeping open.

  2. raiseCatError commented on Oct 16, 2026

    @raiseCatError
    OwnerAuthor

    PR #20 merged and built/signed on hosted macOS with all Swift IPC, job, rename, Undo, compression and toolkit tests passing: https://github.com/raiseCatError/Tuck/actions/runs/38960663919. This was an implementation hygiene pass, not a release. Before release: physical Finder QA, external optional encoder smoke tests, signing/notarization and license/distribution checks remain.

  3. raiseCatError commented on Oct 16, 2026

    @raiseCatError
    OwnerAuthor

    Final feature-integration/pre-release checkpoint (2026-10-17): All feature PRs and ZIP hardening PR #34 are merged. Current main: 7f0e70668d4c7290366170f7e38739f89b3aaa4e. PR #34 final macOS CI passed 13 Swift/test-model suites and built/ad-hoc-signed the helper and Finder extension. README, physical QA and release-readiness documentation are integrated. This is a code-complete candidate for manual testing, NOT a notarized/public release. Remaining gates: real Finder workflows/VoiceOver on user's Mac, representative optional encoders/large jobs/external volumes, signing and notarization strategy, license review and release approval. No tag/release created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions