Skip to content

chore(main): release v1.0.0 - #3

Merged
MatthewSH merged 1 commit into
mainfrom
releaser-pleaser--branches--main
May 14, 2026
Merged

MatthewSH merged 1 commit into
mainfrom
releaser-pleaser--branches--main

Conversation

@github-actions

@github-actions github-actions Bot commented May 14, 2026 •

Copy link
Copy Markdown
Contributor

Features


PR by releaser-pleaser 🤖

If you want to modify the proposed release, add you overrides here. You can learn more about the options in the docs.

Release Notes

Prefix / Start

This will be added to the start of the release notes.

Suffix / End

This will be added to the end of the release notes.

@github-actions github-actions Bot added the rp-release::pending Release for this PR is pending label May 14, 2026
@coderabbitai

coderabbitai Bot commented May 14, 2026 •

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Adds CHANGELOG.md documenting a v1.0.0 release with a BREAKING note and two feature bullets: a distance helper and the initial PDQ codebase (issue #1).

Changes

Release v1.0.0 changelog

Layer / File(s) Summary
Changelog entry for v1.0.0
CHANGELOG.md
Adds CHANGELOG.md with a v1.0.0 release entry, a "BREAKING" note, and feature bullets for a distance helper function and the initial PDQ codebase (issue #1).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A tiny changelog, crisp and new,
v1.0.0 — the rabbit knew.
Distance helper hops in line,
PDQ's first seed begins to shine. 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'chore(main): release v1.0.0' clearly and concisely describes the main change: creating a v1.0.0 release with changelog documentation updates.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch releaser-pleaser--branches--main

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
CHANGELOG.md (1)

3-3: ⚡ Quick win

Consider adding the release date to follow Keep a Changelog format.

The version header would be more informative with the release date included. The Keep a Changelog format recommends: ## [v0.1.0](link) - 2026-05-14

📅 Proposed addition
-## [v0.1.0](https://github.com/MatthewSH/pdq/releases/tag/v0.1.0)
+## [v0.1.0](https://github.com/MatthewSH/pdq/releases/tag/v0.1.0) - 2026-05-14
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CHANGELOG.md` at line 3, Update the release header line that currently reads
"## [v0.1.0](https://github.com/MatthewSH/pdq/releases/tag/v0.1.0)" to include
the release date in Keep a Changelog format (e.g., change to "##
[v0.1.0](https://github.com/MatthewSH/pdq/releases/tag/v0.1.0) - 2026-05-14"),
ensuring the version header string is modified accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@CHANGELOG.md`:
- Line 3: Update the release header line that currently reads "##
[v0.1.0](https://github.com/MatthewSH/pdq/releases/tag/v0.1.0)" to include the
release date in Keep a Changelog format (e.g., change to "##
[v0.1.0](https://github.com/MatthewSH/pdq/releases/tag/v0.1.0) - 2026-05-14"),
ensuring the version header string is modified accordingly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8d6cf7d3-8170-496f-bde9-c57cbcaab0a6

📥 Commits

Reviewing files that changed from the base of the PR and between 6c0af8f and 88146f8.

📒 Files selected for processing (1)
  • CHANGELOG.md

@MatthewSH MatthewSH added rp-next-version::normal Request a stable version rp-next-version::rc Request a pre-release -rc version and removed rp-next-version::normal Request a stable version labels May 14, 2026
@github-actions github-actions Bot changed the title chore(main): release v0.1.0 chore(main): release v0.1.0-rc.0 May 14, 2026
@github-actions
github-actions Bot force-pushed the releaser-pleaser--branches--main branch from 88146f8 to 5a20116 Compare May 14, 2026 21:40
@MatthewSH MatthewSH removed the rp-next-version::rc Request a pre-release -rc version label May 14, 2026
@github-actions github-actions Bot changed the title chore(main): release v0.1.0-rc.0 chore(main): release v0.1.0 May 14, 2026
@github-actions
github-actions Bot force-pushed the releaser-pleaser--branches--main branch from 5a20116 to a9604ae Compare May 14, 2026 21:42
@github-actions github-actions Bot changed the title chore(main): release v0.1.0 chore(main): release v1.0.0 May 14, 2026
@github-actions
github-actions Bot force-pushed the releaser-pleaser--branches--main branch from a9604ae to e277b41 Compare May 14, 2026 21:44
@github-actions github-actions Bot changed the title chore(main): release v1.0.0 chore(main): release v0.1.0 May 14, 2026
@github-actions
github-actions Bot force-pushed the releaser-pleaser--branches--main branch from e277b41 to 586edb3 Compare May 14, 2026 21:45
@github-actions github-actions Bot changed the title chore(main): release v0.1.0 chore(main): release v1.0.0 May 14, 2026
@github-actions
github-actions Bot force-pushed the releaser-pleaser--branches--main branch from 586edb3 to f7e79d8 Compare May 14, 2026 21:45

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CHANGELOG.md`:
- Line 7: Update the "**BREAKING**: release 1.0.0" changelog entry to include a
concise description of what changed, the impact (which APIs/behaviors are
incompatible), and clear migration steps or examples for consumers;
specifically, replace or augment the existing line "**BREAKING**: release 1.0.0"
with a short summary of the breaking change, list affected
functions/endpoints/modules, provide recommended code changes or a migration
snippet, and optionally link to related docs or issue/PR numbers for more
context.
- Line 3: The CHANGELOG contains "## [v1.0.0]" (and another "v1.0.0" occurrence)
but the PR title/release is v0.1.0; update the version strings in CHANGELOG.md
(replace "v1.0.0" instances such as the heading "## [v1.0.0]" and the other
occurrence on line 7) to the intended release version (e.g., "v0.1.0"), or
alternatively change the PR title/configuration to match the version in
CHANGELOG so both are consistent.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e88210a3-d26c-4172-b5cc-75f894ee5cda

📥 Commits

Reviewing files that changed from the base of the PR and between 5a20116 and f7e79d8.

📒 Files selected for processing (1)
  • CHANGELOG.md

Comment thread CHANGELOG.md
Comment thread CHANGELOG.md
@MatthewSH
MatthewSH merged commit ddc1155 into main May 14, 2026
4 checks passed
@MatthewSH
MatthewSH deleted the releaser-pleaser--branches--main branch May 14, 2026 21:48
@github-actions github-actions Bot added rp-release::tagged Release for this PR is created and removed rp-release::pending Release for this PR is pending labels May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rp-release::tagged Release for this PR is created

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant