v0.5.0 changelog

[nman98]

Summary by CodeRabbit

• New Features

  • Added zstd compression support
  • API enhancements with cursor-based pagination
  • Base64 and Base64URL utility functions
  • Docker image and Compose configuration updates

• Changes

  • Route restructuring for better organization
  • Performance optimizations
  • Updated Go version support

[qodo-code-review]

Review Summary by Qodo

Add v0.5.0 changelog with features and improvements

📝 Documentation

Walkthroughs

Description

• Add v0.5.0 release notes with new features
• Document zstd compression implementation status
• List API improvements and docker deployment
• Record dependency and Go version updates

Diagram

flowchart LR
  A["v0.5.0 Release"] --> B["New Features"]
  A --> C["API Improvements"]
  A --> D["Infrastructure"]
  B --> B1["Zstd Compression"]
  B --> B2["Dictionary Training CLI"]
  C --> C1["Base64 Utilities"]
  C --> C2["Cursor Pagination"]
  C --> C3["Route Renaming"]
  D --> D1["Docker Image"]
  D --> D2["Docker Compose"]
  D --> D3["Dependencies Update"]

Loading

File Changes

1. CHANGELOG.md 📝 Documentation +28/-0

Document v0.5.0 release notes and features

• Added v0.5.0 release section dated 2026-03-05
• Documented zstd compression feature (development status)
• Listed new API routes, pagination, and Base64 utilities
• Recorded docker image and compose file additions
• Noted Go version upgrade to 1.25.7 and dependency updates

CHANGELOG.md

---

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 📎 Requirement gaps (0)

1. Changelog typos/spacing 🐞 Bug ✧ Quality

Description

The new 0.5.0 notes contain grammatical/spacing errors (e.g., “This it is …”, “docker(for …)”) which
reduces clarity and professionalism of user-facing release notes.

Code

CHANGELOG.md[R12-19]

+The zstd compression has been added. This it is not production ready and still in development, however
+initial testing has been done and it seems to work, about 30% less storage is required.
+
+The API has been improved with some new routes and minor improvements. The cursor based pagination has been added
+to the API on certain routes. The API now also has POST utilities to convert between Base64 and Base64URL.
+
+The docker image for the API has been added. This allows for easy deployment of the API via docker.
+The docker compose file has been adjusted for full deployment via docker(for production and development).

Evidence

The 0.5.0 section introduces these exact typos in the newly added paragraphs, making the release
notes harder to read.

CHANGELOG.md[8-20]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The v0.5.0 changelog entry contains typos/formatting issues that reduce readability (e.g., “This it is …”, “docker(for …)”).

### Issue Context
This PR only changes `CHANGELOG.md`, so documentation quality is the primary deliverable.

### Fix Focus Areas
- CHANGELOG.md[12-19]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

2. Changed/Changes header mix 🐞 Bug ✧ Quality

Description

The changelog mixes section headers “### Changes” and “### Changed”; the new 0.5.0 entry continues
this inconsistency, which diverges from Keep a Changelog conventions and makes the document harder
to scan (and potentially harder to parse if tooling is added later).

Code

CHANGELOG.md[R29-34]

+### Changes
+
+- Renamed routes of some API routes to be more descriptive.
+- Docker compose adjusted for full deployment via docker(for production and development)
+- Some minor performance improvements during data processing.
+- Updated the go version to 1.25.7 and all of the dependencies to the latest version.

Evidence

The new 0.5.0 entry uses “### Changes”, while other entries use “### Changed”, demonstrating
inconsistent naming within the same document.

CHANGELOG.md[29-34]
CHANGELOG.md[60-65]
CHANGELOG.md[45-46]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`CHANGELOG.md` uses both `### Changes` and `### Changed`. The new v0.5.0 entry adds another `### Changes`, perpetuating inconsistency.

### Issue Context
Keep a Changelog’s conventional header is `### Changed`.

### Fix Focus Areas
- CHANGELOG.md[29-34]
- CHANGELOG.md[45-46]
- CHANGELOG.md[60-65]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

ⓘ The new review experience is currently in Beta. Learn more

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a750efed-7532-4757-a74c-9cf55f6ab5cd

📥 Commits

Reviewing files that changed from the base of the PR and between d8596a6 and 62cafa7.

📒 Files selected for processing (1)

• CHANGELOG.md

---

📝 Walkthrough

Walkthrough

A new release entry for version 0.5.0 (dated 2026-03-05) is added to the changelog, documenting new features including zstd compression, API enhancements, cursor-based pagination, and Base64 utilities, along with component updates and performance improvements.

Changes

Cohort / File(s)	Summary
Changelog Entry CHANGELOG.md	Added new release section for version 0.5.0 with details on new features (zstd compression, API enhancements, cursor-based pagination, Base64/Base64URL utilities, Docker updates), improvements (route renames, performance tweaks, Go version bump).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A changelog hops into place,
With version numbers we embrace,
0.5.0 marks the day,
New features hop our way!
Compression, pagination, and more,
Our system's improved at its core. ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}