Skip to content

docs: CHANGELOG, v0.1.0-alpha.2, release notes workflow#29

Merged
cedoor merged 1 commit into
mainfrom
docs/changelog-issue-26
Apr 28, 2026
Merged

docs: CHANGELOG, v0.1.0-alpha.2, release notes workflow#29
cedoor merged 1 commit into
mainfrom
docs/changelog-issue-26

Conversation

@cedoor
Copy link
Copy Markdown
Owner

@cedoor cedoor commented Apr 28, 2026

Summary

  • Adds root CHANGELOG.md in Keep a Changelog format and documents v0.1.0-alpha.2 (this change set).
  • Bumps the published squid crate to 0.1.0-alpha.2.
  • Adds .cursor/rules/changelog.mdc: merge PRs should append to ## [Unreleased]; that block is promoted when cutting the next version.
  • Registers the rule in CLAUDE.md.

Closes #26.

Post-merge

Tag and GitHub Release for v0.1.0-alpha.2 should be created from main after merge.

Summary by CodeRabbit

  • Documentation

    • Added CHANGELOG.md documenting release history and version changes.
  • Chores

    • Bumped package version to 0.1.0-alpha.2.

- Add CHANGELOG.md (Keep a Changelog); document v0.1.0-alpha.2 (#26).
- Bump `squid` crate to 0.1.0-alpha.2.
- Add changelog.mdc (Unreleased on merge; relocate at release).
- Link the rule from CLAUDE.md.
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
poulpy-js-demo Building Building Preview, Comment Apr 28, 2026 1:35pm

@cedoor cedoor merged commit 49fc3e2 into main Apr 28, 2026
3 of 4 checks passed
@cedoor cedoor deleted the docs/changelog-issue-26 branch April 28, 2026 13:35
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 13edf058-ebe5-499a-b33b-79ecf2a82e49

📥 Commits

Reviewing files that changed from the base of the PR and between 0539da5 and 69bbc53.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • .cursor/rules/changelog.mdc
  • CHANGELOG.md
  • CLAUDE.md
  • crates/squid/Cargo.toml

📝 Walkthrough

Walkthrough

This pull request introduces a structured changelog system by adding CHANGELOG.md in Keep a Changelog format, defining Cursor rules for changelog maintenance, updating documentation references, and bumping the package version to 0.1.0-alpha.2.

Changes

Cohort / File(s) Summary
Changelog Infrastructure
.cursor/rules/changelog.mdc, CHANGELOG.md
Added changelog file following Keep a Changelog conventions and defined workflow rules for maintaining [Unreleased] section and cutting releases with version bumps, Git tags, and link updates.
Documentation Index
CLAUDE.md
Added reference to new changelog rule file documenting Keep a Changelog policy and merge requirements.
Package Manifest
crates/squid/Cargo.toml
Bumped package version from 0.1.0-alpha.1 to 0.1.0-alpha.2 to reflect changelog feature introduction.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A changelog now greets the release,
With [Unreleased] to find us peace,
Keep it tidy, bump with care,
Version notes recorded fair! 📝✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/changelog-issue-26

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CHANGELOG file

1 participant