diff --git a/CHANGELOG.md b/CHANGELOG.md index f8d9cc5..f9ac3a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,99 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] -## [0.1.2] - 2026-02-07 +### Bug Fixes -### Added +- **security**: Redact sensitive session IDs in marathonctl output -- **marathonctl CLI Tool**: New standalone command-line tool for controlling Marathon instances - - Beautiful TUI using ratatui with inline viewport mode - - Session status, peer list, and entity management commands - - `--show-sensitive` flag for debugging with full session IDs - - Easy-to-extend UI module with builder pattern API +- **deps**: Update lru to 0.16.3 to address Dependabot alert #1 -### Security -- **Session ID Redaction**: Marathon CLI now redacts session IDs by default to prevent accidental exposure - - Shows only first 8 characters (e.g., `abc-def-...`) - - Explicit `--show-sensitive` flag required to view full IDs - - Fixes CodeQL cleartext-logging alerts (#1, #2, #3) -- **Dependency Updates**: Updated `lru` crate to v0.16.3 to address memory safety vulnerability - - Fixes Dependabot alert #1 (CVE: IterMut violates Stacked Borrows) - - Updated ratatui v0.29 → v0.30 - - Updated pkarr v5.0.0 → v5.0.2 +### Miscellaneous Tasks -### Changed +- **marathonctl**: Add crates.io metadata for publishing -- Extracted `marathonctl` from app crate into standalone publishable crate -- Updated all Marathon crate versions to 0.1.2 for consistency - - libmarathon: 0.1.2 - - libmarathon-macros: 0.1.2 - - marathonctl: 0.1.2 +- **libmarathon**: Add CodeQL suppression for database secret storage -### Documentation +- Update CHANGELOG for v0.1.2 release -- Added `.envrc` setup instructions in CONTRIBUTING.md for GitHub token management -- Added crates.io publishing metadata to marathonctl - -### Fixed - -- Removed unnecessary ratatui/crossterm dependencies from app crate -- Added CodeQL suppression comment for database secret storage (false positive) ## [0.1.0] - 2026-02-06 -### Added - -#### Core Features -- CRDT-based synchronization using OR-Sets, RGA, and Last-Write-Wins semantics -- Peer-to-peer networking built on iroh with QUIC transport -- Gossip-based message broadcasting for multi-peer coordination -- Offline-first architecture with automatic reconciliation -- SQLite-backed persistence with WAL mode -- Cross-platform support for macOS desktop and iOS - -#### Demo Application -- Replicated cube demo showcasing real-time collaboration -- Multiple instance support for local testing -- Apple Pencil input support on iPad -- Real-time cursor and selection synchronization -- Debug UI for inspecting internal state - -#### Infrastructure -- Bevy 0.17 ECS integration -- Zero-copy serialization with rkyv -- Automated iOS build tooling via xtask -- Comprehensive RFC documentation covering architecture decisions - -### Architecture - -- **Networking Layer**: CRDT sync protocol, entity mapping, vector clocks, session management -- **Persistence Layer**: Three-tier system (in-memory → write buffer → SQLite) -- **Engine Core**: Event loop, networking manager, peer discovery, game actions -- **Platform Support**: iOS and desktop with platform-specific input handling - -### Documentation - -- RFC 0001: CRDT Synchronization Protocol -- RFC 0002: Persistence Strategy -- RFC 0003: Sync Abstraction -- RFC 0004: Session Lifecycle -- RFC 0005: Spatial Audio System -- RFC 0006: Agent Simulation Architecture -- iOS deployment guide -- Estimation methodology documentation - -### Known Issues - -- API is unstable and subject to change -- Limited documentation for public APIs -- Performance optimizations still needed for large-scale collaboration -- iOS builds require manual Xcode configuration - -### Notes - -This is an early development release (version 0.x.y). The API is unstable and breaking changes are expected. Not recommended for production use. - -[unreleased]: https://github.com/r3t-studios/marathon/compare/v0.1.2...HEAD -[0.1.2]: https://github.com/r3t-studios/marathon/compare/v0.1.0...v0.1.2 -[0.1.0]: https://github.com/r3t-studios/marathon/releases/tag/v0.1.0 + diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..c0df833 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,84 @@ +# git-cliff configuration file +# https://git-cliff.org/docs/configuration + +[changelog] +# changelog header +header = """ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n +""" +# template for the changelog body +body = """ +{% if version %}\ + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} +{% else %}\ + ## [Unreleased] +{% endif %}\ +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | upper_first }} + {% for commit in commits %} + - {% if commit.scope %}**{{ commit.scope }}**: {% endif %}{{ commit.message | upper_first }}\ + {% if commit.breaking %} [**BREAKING**]{% endif %} + {% endfor %} +{% endfor %}\n +""" +# template for the changelog footer +footer = """ + +""" +# remove the leading and trailing whitespace from the templates +trim = true + +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = true +# filter out the commits that are not conventional +filter_unconventional = true +# process each line of a commit as an individual commit +split_commits = false +# regex for preprocessing the commit messages +commit_preprocessors = [ + # Remove issue numbers from commits + # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" }, +] +# regex for parsing and grouping commits +commit_parsers = [ + { message = "^feat", group = "Features" }, + { message = "^fix", group = "Bug Fixes" }, + { message = "^doc", group = "Documentation" }, + { message = "^perf", group = "Performance" }, + { message = "^refactor", group = "Refactoring" }, + { message = "^style", group = "Styling" }, + { message = "^test", group = "Testing" }, + { message = "^chore\\(release\\):", skip = true }, + { message = "^chore\\(deps\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore|ci", group = "Miscellaneous Tasks" }, + { body = ".*security", group = "Security" }, + { message = "^revert", group = "Revert" }, +] +# protect breaking changes from being skipped due to matching a skipping commit_parser +protect_breaking_commits = false +# filter out the commits that are not matched by commit parsers +filter_commits = false +# regex for matching git tags +tag_pattern = "v[0-9].*" +# regex for skipping tags +skip_tags = "" +# regex for ignoring tags +ignore_tags = "" +# sort the tags topologically +topo_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "oldest" +# limit the number of commits included in the changelog. +# limit_commits = 42 + +[remote.github] +owner = "r3t-studios" +repo = "marathon"