Skip to content

Generate pre-distribution audit and fix blocking packaging/documentation issues#140

Merged
szmyty merged 2 commits intomainfrom
copilot/generate-pre-distribution-audit
Mar 28, 2026
Merged

Generate pre-distribution audit and fix blocking packaging/documentation issues#140
szmyty merged 2 commits intomainfrom
copilot/generate-pre-distribution-audit

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 28, 2026

Generates a structured release-readiness audit (audits/audit-2026-03-28T054023Z.log) evaluating Renderflow across build, CLI UX, dependency validation, docs, code quality, robustness, distribution, performance, and architecture. Also applies all CRITICAL findings identified by the audit.

Audit file

  • Covers all 9 required areas with CRITICAL / WARNING / MINOR findings
  • Includes POSITIVE OBSERVATIONS and a clear RELEASE READINESS STATUS verdict
  • Identifies remaining blockers (missing release workflow) and estimates ~1–2 hours of follow-up work

Cargo.toml — packaging metadata

Added fields required/recommended for cargo publish:

rust-version = "1.75"
repository   = "https://github.com/egohygiene/renderflow"
homepage     = "https://github.com/egohygiene/renderflow"
keywords     = ["document", "rendering", "pandoc", "markdown", "pdf"]
categories   = ["command-line-utilities", "development-tools", "text-processing"]
authors      = ["Ego Hygiene <egohygiene@users.noreply.github.com>"]

[profile.release]
opt-level     = 3
lto           = true
codegen-units = 1
strip         = true
panic         = "abort"

README — factual corrections

  • DOCX output was fully implemented but omitted from Features and the Supported Output Types table — fixed
  • DOCX and watch mode still listed as roadmap items despite being shipped — removed
  • Added watch mode to the Features list

Dead-code warnings — 4 suppressed

All four warnings were on intentional forward-looking API surface (populated but not yet consumed):

Location Symbol Reason not yet used
strategy.rs RenderContext.variables Variable substitution handled in transform phase
strategy.rs RenderContext.dry_run Build command short-circuits before invoking strategies
registry.rs TransformRegistry::with_fail_fast Builder method; exercised in tests only
pipeline.rs Pipeline::add_transform Builder method; exercised in tests only

Suppressed with targeted #[allow(dead_code)] with clarifying doc comments rather than removing the API.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Mar 28, 2026
Copilot AI changed the title [WIP] Generate pre-distribution audit for release readiness and cleanup Generate pre-distribution audit and fix blocking packaging/documentation issues Mar 28, 2026
Copilot AI requested a review from szmyty March 28, 2026 05:55
@szmyty szmyty marked this pull request as ready for review March 28, 2026 17:49
@szmyty szmyty merged commit deb841b into main Mar 28, 2026
@devactivity-app
Copy link
Copy Markdown

Pull Request Summary by devActivity

Metrics

Cycle Time: 12h 10m Pickup Time: 11h 54m Review Time: < 1 min

Achievements

@szmyty szmyty deleted the copilot/generate-pre-distribution-audit branch March 28, 2026 17:50
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.

🧠 Generate pre-distribution audit (release readiness + cleanup + packaging validation)

2 participants