Skip to content

CHANGELOG.md

Latest commit

 

History

History
112 lines (95 loc) · 5.73 KB

CHANGELOG.md

File metadata and controls

112 lines (95 loc) · 5.73 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

  • bootcamp diff <owner/repo#pr> command for onboarding-focused PR diffing
  • Developer workflow scripts: format, format:check, typecheck, and dev:web
  • lint-staged configuration for husky pre-commit usage
  • Formatter snapshot tests for markdown/HTML/PDF output stability in test/formatter.test.ts
  • Supertest HTTP-level web server tests for routes, error paths, rate limiting, and security headers
  • Vitest global coverage thresholds (lines: 80, branches: 70)
  • CI test matrix support for Node.js 24
  • PR dependency scanning with actions/dependency-review-action
  • SBOM generation/upload in CI via npm sbom --sbom-format spdx
  • Separate CI jobs for linting and type-checking
  • Programmatic API entry modules (src/api.ts, src/lib.ts) with package root re-export from src/index.ts
  • CLI/core split with src/cli.ts as bin entrypoint (dist/cli.js) and library-safe src/index.ts
  • Project config file discovery via cosmiconfig (.bootcamprc, bootcamp.config.ts, and related variants)
  • Config defaults support for audience/focus/style/model/maxFiles with CLI-over-config precedence
  • Agent dependency injection interfaces (LlmClient, LlmSession, AnalyzeRepoDependencies) for testable client wiring
  • npm exports map with subpath exports (./api, ./lib, and focused modules) for ESM/CJS consumers
  • CJS build output generation (dist/cjs) for require(...) compatibility alongside ESM output
  • Multi-host repository URL support (GitHub, GitLab, Bitbucket) with normalized parsing metadata
  • Monorepo detection for npm workspaces, pnpm workspaces, Lerna, Nx, and Turborepo
  • Typed plugin API (src/plugin-api.ts) supporting analyzer, formatter, and output-target plugin stages
  • Architecture Decision Records in docs/adr/ for Copilot SDK, Express, cache strategy, and plugin architecture
  • Structured GitHub issue forms (bug.yml, feature.yml) and pull request template
  • npm provenance badge and related documentation updates in README.md

Fixed

  • Reused shared prompt helper builders in src/agent.ts for standard/fast prompt construction.
  • Preserved caught error causes in src/watch.ts non-fast-forward rethrows.
  • Added missing web middleware dependencies/types (helmet, express-rate-limit, @types/helmet) for type-checking.
  • Streamed Copilot assistant output incrementally in analysis flows (verbose stdout and non-verbose progress updates).
  • Added model-aware fast-mode inline file budgets based on selected model context window.
  • Switched repository walking to concurrent fast-glob traversal while preserving skip/max-file behavior.
  • Added phase-level analyzer cache entries for dependency, security, and impact analysis.
  • Hardened async error boundaries for Copilot timeouts (src/agent.ts), clone failures (src/ingest.ts), and web request handling (src/web/routes.ts).
  • Hardened repository URL/branch sanitization before clone execution and added safer clone path construction.
  • Replaced coarse API throttling with endpoint-level limits (/api/analyze: 5/15m, other API routes: 100/15m).

1.0.0 - 2026-01-25

Added

  • Core Features

    • Agentic repository analysis using GitHub Copilot SDK
    • Generate 12+ interconnected markdown documentation files
    • Support for TypeScript, Python, Go, Rust, Java, and more languages
    • Schema validation with Zod and auto-retry on failures
    • Smart file prioritization and byte budget management

  • CLI Commands

    • bootcamp <url> - Generate full bootcamp documentation
    • bootcamp ask <url> - Interactive Q&A mode without full generation
    • bootcamp web - Start local web demo server

  • CLI Options

    • --branch - Analyze specific branch
    • --focus - Focus on onboarding, architecture, contributing, or all
    • --audience - Target backend, frontend, or sre
    • --output - Custom output directory
    • --style - Output styles: corporate, startup, oss, academic, minimal
    • --interactive - Start Q&A mode after generation
    • --compare - Compare with git ref for version diffing
    • --create-issues - Create GitHub issues from starter tasks
    • --render-diagrams - Render Mermaid to SVG/PNG
    • --fast - Fast mode with inlined files (~15-30s)
    • --json-only - Only generate repo_facts.json
    • --no-clone - Use GitHub API instead of cloning

  • Generated Documentation

    • BOOTCAMP.md - 1-page overview
    • ONBOARDING.md - Complete setup guide
    • ARCHITECTURE.md - System design with Mermaid diagrams
    • CODEMAP.md - Directory tour
    • FIRST_TASKS.md - 8-10 starter issues by difficulty
    • RUNBOOK.md - Operations guide
    • DEPENDENCIES.md - Dependency graph and analysis
    • SECURITY.md - Security patterns and findings
    • RADAR.md - Tech radar and onboarding risk score
    • IMPACT.md - Change impact analysis
    • diagrams.mmd - Mermaid diagram sources
    • repo_facts.json - Structured data for automation

  • Analysis Features

    • Tech radar for identifying modern, stable, legacy, and risky technologies
    • Security analysis with scoring
    • Change impact analysis for key files
    • Dependency graph generation
    • Version comparison (DIFF.md)

  • Integrations

    • GitHub issue creation from starter tasks
    • Web demo server with Express
    • Plugin system for custom analyzers
    • Template packs for output customization

  • Developer Experience

    • 205 passing tests with Vitest
    • Full TypeScript support
    • Beautiful CLI output with progress indicators
    • Streaming responses during analysis