Changelog#

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

[0.2.2] - 2026-07-05#

Bug Fixes#

• ci: Add uv tool so pipx tools use the uvx backend (#82)

Documentation#

• readme: Simplifies mmap-guard description

Miscellaneous Tasks#

• Repo-config cleanup (CodeRabbit filename + untrack .vscode/settings.json) (#71)

[0.2.1] - 2026-06-24#

Bug Fixes#

• deps: Migrate to fs4 1.1 lock API + memmap2 0.9.11 (RUSTSEC-2026-0186) (#61)

Testing#

• fuzz: Enhance fuzzing capabilities and CI workflows with documentation (#10)

Miscellaneous Tasks#

• mergify: Upgrade configuration to current format (#35)
• Fix garbled mise-action version pin comment (v4.0.1) (#63)

[0.2.0] - 2026-03-08#

Features#

• security: Add security policy and vulnerability reporting guidelines
• docs: Add contributing guidelines and code of conduct
• docs: Add third-party notices and license information
• docs: Add GOTCHAS.md for unsafe code and development guidelines
• docs: Update license information and structure in about.hbs and about.toml
• Enhance mmap functionality and update related documentation (#4)

Bug Fixes#

• Enhance documentation and optimize IO buffer allocation (#8)

Documentation#

• lib: Update documentation links for clarity and consistency
• contributing: Update guidelines to include GOTCHAS.md reference
• licenses: Add third-party notices and Apache License 2.0 text
• Fix stale comments post advisory-locking (#5)

Miscellaneous Tasks#

• lib: Add THIRD_PARTY_NOTICES.md to markdownlint ignores
• Update .gitignore, add CHANGELOG, and modify deny.toml
• mise: Add mise-lock-check hook to ensure mise.lock sync
• ci: Add install_args to jdx/mise-action for consistency

[0.1.0] - 2026-03-08#

Features#

• Add mise.toml for tool version management and settings configuration
• Add rust-toolchain.toml and rustfmt.toml for toolchain and formatting configuration
• Add .pre-commit-config.yaml for code quality checks and hooks and add .prettierignore to exclude specific file types from formatting
• Add Cargo.toml for project configuration and dependencies management
• Add .coderabbitai.yaml for configuration and automation settings
• Add justfile for cross-platform task management and automation
• Add cliff.toml for changelog configuration and release-plz.toml for release management
• Add security workflow for automated audits and checks
• Add GitHub Actions workflow for auditing Rust dependencies
• Add Scorecard workflow for supply-chain security analysis
• Add markdownlint and mdformat configuration files for consistent formatting
• Add cargo-deny configuration for dependency management and license compliance
• Add configuration files for Dependabot and Codecov
• Add CI, documentation deployment, and release workflows
• Add DCO configuration to allow remediation commits
• Add FUNDING.yml to support funding model platforms
• vscode: Add settings for Git and GitHub integration
• ci: Add Mergify configuration for auto-approval and merging
• docs: Add comprehensive documentation for mmap-guard library
• security: Add security policy and vulnerability reporting guidelines
• docs: Add contributing guidelines and code of conduct
• docs: Add third-party notices and license information
• docs: Add GOTCHAS.md for unsafe code and development guidelines
• docs: Update license information and structure in about.hbs and about.toml
• mmap: Enhance FileData for advisory locking and update documentation
• mmap: Document shared advisory lock in map_file function
• docs: Update README to include advisory locking and file data changes
• docs: Add security assurance case documentation
• lib: Enhance CLI path handling and stdin reading logic
• docs: Update README to clarify load function behavior

Bug Fixes#

• Update cargo-sort to version 2.1.1
• Update ci-check command to exclude dist-plan for library crate
• ci: Update lint-actions to include docs workflow
• Address PR review feedback from Copilot

Documentation#

• Add AGENTS.md with project guidance and CLAUDE.md reference
• Add commit message style guidelines for mmap-guard
• docs: Enhance AGENTS.md with detailed architecture and linting info
• docs: Enhance README with comprehensive usage and architecture details
• lib: Update documentation links for clarity and consistency
• contributing: Update guidelines to include GOTCHAS.md reference
• licenses: Add third-party notices and Apache License 2.0 text
• GOTCHAS: Update clippy lints and document load/load_stdin behavior
• CONTRIBUTING: Clarify load function routing in architecture overview
• GOTCHAS: Document denial of uninlined_format_args lint
• introduction: Update license section to include MIT option

Styling#

• Format keywords and categories for consistency
• Reorganize .gitignore for clarity and consistency

Testing#

• load: Add test for stdin routing in load function
• load: Remove redundant test for stdin routing in resolve_source

Miscellaneous Tasks#

• ci: Add permissions section to CI and audit workflows
• lib: Add THIRD_PARTY_NOTICES.md to markdownlint ignores
• mmap: Remove redundant code blocks from changes section
• Add docs-check to CI pipeline for documentation validation