Skip to content

changelog

Jump to bottom
Ary Rabelo edited this page Jul 22, 2026 · 3 revisions

Changelog

Relevant source files

  • CHANGELOG.md

Overview

RepoDocs records its release history in CHANGELOG.md following the Keep a Changelog format and Semantic Versioning. Two releases are recorded to date: 0.1.0 and 0.2.0, plus an [Unreleased] heading with no entries yet.

Sources: CHANGELOG.md:L1-L9

Release history

Version Date Summary
Unreleased — No entries yet
0.2.0 2026-07-22 Wiki publishing, diagram rendering, PyPI trusted publishing, package restructuring, citation self-repair, and multiple security hardening fixes
0.1.0 2026-07-21 Initial release: scanning, planning, cited generation, incremental rebuilds, publishing, installer

Sources: CHANGELOG.md:L7-L46

0.2.0 (2026-07-22)

Added

  • publish-wiki command that exports generated Markdown to a GitHub Wiki, mapping overview.md to Home.md, generating _Sidebar.md from plan order, rewriting citations to commit-pinned GitHub blob URLs, and preserving unrelated manual wiki pages.
  • render-diagrams command and an optional Bun/Playwright tool (tools/diagram_poster.ts) that pre-renders Markdown mermaid blocks to committed pastel PNGs, swapping the block for an image embed so published wikis display diagrams even if GitHub's own Mermaid renderer fails; kept out of the zero-dependency Python core, with publish-wiki staging the committed PNGs.
  • A PyPI Trusted-Publishing release workflow (.github/workflows/publish.yml) that builds and publishes repodocs on a v* tag via OIDC, guarded by a tag/VERSION match check.
  • CLAUDE.README.md, an agent-facing orientation file for coding agents working in the repo.

Sources: CHANGELOG.md:L11-L16

Changed

  • Claude Code with claude-sonnet-5 became the default backend, requiring no environment variables for repodocs-all . after authentication; OMP and Codex remain available via REPODOCS_BACKEND=omp|codex.
  • Distribution switched to standard Python packaging via uvx/uv tool install, exposing repodocs and repodocs-all console commands without a persistent source clone.
  • The single-file driver became a repodocs package (src/repodocs/, one module per pipeline stage); the former in-module --selftest moved to a tests/ pytest suite, and a CI guardrail keeps every shipped module under 500 lines. Run locally with python -m repodocs.

Sources: CHANGELOG.md:L18-L22

Fixed

  • Citation generation now self-repairs mechanically-fixable citations before the blocking check: an end line one past EOF is clamped to the file's real length, labels missing the L prefix or written single-line are canonicalized, and a dropped src/<pkg>/ path prefix is resolved against the unique matching tracked file. Citations that cannot be made honest are still left for the publish gate to block.

Sources: CHANGELOG.md:L24-L26

Security

  • publish and publish-wiki now block on missing or invalid source citations (nonexistent path, path traversal/symlink escape, out-of-range or reversed line range, or a label disagreeing with its link target), enforcing the source-cited guarantee before any push instead of only warning.
  • The offline HTML viewer sanitizes rendered Markdown with DOMPurify, blocking script injection, event-handler attributes, and javascript: URLs from repository-derived content.
  • Repository scanning no longer ingests RepoDocs' own generated output (repo-docs/, graphify-out/, the configured --out directory) or files reached through symlinks that escape the repository.
  • Vendored offline assets ship a THIRD-PARTY-NOTICES.txt reproducing the marked, Mermaid, highlight.js, and DOMPurify licenses.
  • Citation link rewriting HTML-escapes link text and percent-escapes paths, preventing untrusted Markdown from injecting attributes or tags into generated <a> elements.
  • publish and publish-wiki staging reject symlinked source pages before any read or copy, and surface bounded errors rather than raw git output on push failure.
  • The offline viewer fails closed when DOMPurify cannot load and runs Mermaid in securityLevel: "strict".

Sources: CHANGELOG.md:L28-L36

0.1.0 (2026-07-21)

Added

  • Deterministic repository scanning and feature-level wiki planning.
  • Cited page generation through OMP, Claude Code, or Codex.
  • Incremental rebuilds, translation, and a self-contained HTML viewer.
  • Safe GitHub Pages publishing with branch and secret checks.
  • Standalone installer, vendored agent contracts, and self-test.

Sources: CHANGELOG.md:L38-L46

Pages

Clone this wiki locally