Skip to content

CHANGELOG.md

Latest commit

 

History

History
135 lines (111 loc) · 6.77 KB

CHANGELOG.md

File metadata and controls

135 lines (111 loc) · 6.77 KB
Raw

Changelog

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

The format follows Keep a Changelog and adheres to Semantic Versioning.

[v0.3.0] — Unified Intelligence Release

Added

  • Unified Intelligence Layer – Cross-provider normalization into standardized metadata schemas
  • Intelligence summarization – New --summarize flag for analytical insights (requires --repos)
  • Enhanced output control – New --pretty flag for human-readable JSON formatting (requires --raw)
  • Version tracking – New --version flag for release identification
  • Structured reporting module – Clean terminal presentation via lib/report.sh
  • Unified output schemas – Authoritative contracts for cross-platform intelligence:
    • schemas/unified_user.json
    • schemas/unified_repo.json
  • Full Portuguese translation – Complete documentation localization for v0.3.0 features

Enhanced

  • Normalization functions – Renamed from parse_* to normalize_* reflecting architectural evolution
  • CLI orchestration – Extended with intelligence workflow support (-r -s combination)
  • Integration tests – Updated for unified schema validation and intelligence output verification
  • Documentation structure – Complete refactor with separation of concerns:
    • setup.md – Pure installation and environment validation
    • usage.md – Comprehensive operational guide for v0.3.0 features
    • osint-flow.md – Updated mental model with intelligence layer integration
  • API field mapping documentation – Unified cross-provider mappings:
    • docs/api_maps/unified-user-map.md
    • docs/api_maps/unified-repo-map.md
  • Navigation system – Updated sidebar synchronization across language versions

Design Notes

  • Unified schemas are authoritative – Providers adapt to common contracts, not vice versa
  • Intelligence is strictly additive – Raw data remains fully accessible via --raw flag
  • Presentation is decoupled – Report module handles formatting only, no data collection
  • Cross-provider comparison enabled – Common field names despite platform-specific limitations
  • GitLab API constraints documented – Language field explicitly noted as "N/A" in summaries
  • Backward compatibility maintained – All existing CLI flags and behaviors unchanged
  • Minimal dependency footprint preserved – No new runtime dependencies introduced

Documentation

  • Complete workflow documentation for intelligence summarization features
  • Platform-specific constraint documentation (GitLab language limitations)
  • Examples for combined flag usage (--repos --summarize, --raw --pretty)
  • Updated OSINT flow to reflect intelligence layer as logical extension
  • Multilingual navigation consistency across English and Portuguese versions

Known Limitations

  • GitHub-centric intelligence – Language analysis limited to GitHub (GitLab returns "N/A")
  • Summarization dependency – --summarize requires explicit --repos flag
  • Pretty formatting scope – --pretty only affects output when combined with --raw
  • Platform asymmetry – Some intelligence features (top languages) unavailable for GitLab
  • First-page limitation – Pagination not implemented (affects repositories >100 items)
  • No temporal comparison – Snapshot comparison or change tracking not yet implemented

v0.2.0 — Repository Enumeration Release

Added

  • Public repository enumeration for GitHub – Unauthenticated repository listing via /users/{username}/repos
  • Public project enumeration for GitLab – Unauthenticated project listing via /users/{username}/projects
  • New CLI flag --repos – Opt-in repository/project enumeration after successful user reconnaissance
  • Repository output schemas – Normalized contracts for cross-provider consistency:
    • schemas/github_user_repos.json
    • schemas/gitlab_user_repos.json
  • Enhanced provider orchestration – Combined user and repository flows with explicit scope control
  • Integration test suites – Live API validation for repository endpoints across both providers

Enhanced

  • CLI interface – Extended with repository-specific execution paths while maintaining backward compatibility
  • OSINT flow documentation – Updated mental model to include asset surface discovery phase
  • API field mapping documentation – Comprehensive raw-to-normalized mappings for repository responses
  • Setup and usage guides – Examples and troubleshooting for new enumeration capabilities

Design Notes

  • Repository enumeration is explicit and opt-in (--repos flag required)
  • No authentication logic or rate-limit evasion mechanisms introduced
  • Raw provider responses remain inspectable via --raw flag
  • Schemas act as authoritative output contracts; code conforms to contracts
  • Strict separation between user reconnaissance and asset enumeration phases
  • No implicit scope expansion or recursive traversal

Documentation

  • Extended API field mappings for GitHub repositories and GitLab projects
  • Updated OSINT flow to include conditional repository enumeration step
  • Enhanced setup guide with new flag usage, examples, and edge cases
  • All documentation references upstream provider APIs as authoritative sources

Known Limitations

  • Subject to unauthenticated API rate limits (stricter for repository endpoints)
  • Limited to publicly accessible repositories/projects
  • No cross-provider correlation or deduplication logic
  • No repository content analysis or metadata enrichment
  • Pagination not implemented (first page only)

v0.1.0 — Initial MVP Release

Added

  • Unauthenticated GitHub user reconnaissance
  • Unauthenticated GitLab user reconnaissance
  • Provider-based modular architecture
  • CLI entry point with explicit orchestration layer
  • --raw flag to output unprocessed API responses
  • Normalized JSON output via explicit schemas
  • GitHub user schema (schemas/github_user.json)
  • GitLab user schema (schemas/gitlab_user.json)
  • Core helpers for logging and dependency validation

Documentation

  • Comprehensive README.md with scope, usage, and design principles
  • OSINT flow and mental model documentation
  • API raw → normalized field mappings for GitHub and GitLab
  • Setup and troubleshooting guide
  • Security policy and responsible disclosure guidelines

Design Notes

  • No authentication support by design
  • Schemas act as authoritative output contracts
  • Clear separation between data retrieval, parsing, and orchestration

Known Limitations

  • Unauthenticated rate limits apply
  • Limited to public user endpoints
  • No persistence or data enrichment