Skip to content

Conversation

VladimirTaytor
Copy link
Contributor

@VladimirTaytor VladimirTaytor commented Sep 18, 2025

Motivation

We want to make a new release

Changes

  • Bump version and add changelog

How to test

  • n/a

Summary by CodeRabbit

  • Documentation
    • Added v2.2.0 release notes (2025-09-18) to the changelog.
    • Summarizes new API areas: Emails Sandbox Projects, Email Templates, Contact Fields, Contact Lists, Contacts, Contact Imports, Suppressions, Inboxes, Messages, Attachments.
    • Notes bug fixes, including a potential code-scanning permissions issue.
    • Includes references to related PRs for traceability.
    • No code changes or modifications to public APIs.

Copy link

coderabbitai bot commented Sep 18, 2025

Walkthrough

Added a new 2.2.0 release notes section dated 2025-09-18 to CHANGELOG.md, listing API additions and bug fixes, while retaining the existing 2.1.0 section. No code or public API changes.

Changes

Cohort / File(s) Change Summary
Changelog update
CHANGELOG.md
Prepended a 2.2.0 release notes section (2025-09-18) detailing new APIs and bug fixes; existing 2.1.0 section retained. Documentation-only update.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A nibble of notes on a page so bright,
Version hops forward in the autumn light.
I thump my paws—no code to mend,
Just tidy trails from end to end.
Changelog carrots stacked in rows—
Onward to 2.2.0, the garden grows! 🌱🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title "Bump version to 2.2.0" is concise and directly reflects the primary change in this PR (version bump and changelog addition), making it clear to reviewers and for repository history. It avoids noise and is appropriately specific for a release PR.
Description Check ✅ Passed The PR description provides the required Motivation and Changes sections and states the release intent, and a How to test section is present (marked as "n/a"), so it is largely complete for a documentation/version bump PR. The template's "Images and GIFs" section is not included, but that omission is non-critical for this change.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch release-v2.2.0

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

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

12-12: Typo: “releated” → “related”.

Apply:

- - Fix issue #26: Add MessagesApi, releated models, examples, tests by @Ihor-Bilous in https://github.com/railsware/mailtrap-python/pull/43
+ - Fix issue #26: Add MessagesApi, related models, examples, tests by @Ihor-Bilous in https://github.com/railsware/mailtrap-python/pull/43

3-4: Make phrasing consistent with other bullets (“Fix issue #N:” pattern).

Apply:

- - Fix issue #29. Add support of Emails Sandbox (Testing) API: Projects by @Ihor-Bilous in https://github.com/railsware/mailtrap-python/pull/31
+ - Fix issue #29: Add support for Emails Sandbox (Testing) API: Projects by @Ihor-Bilous in https://github.com/railsware/mailtrap-python/pull/31
- - Issue 25 by @Ihor-Bilous in https://github.com/railsware/mailtrap-python/pull/33
+ - Fix issue #25 by @Ihor-Bilous in https://github.com/railsware/mailtrap-python/pull/33

11-11: Remove stray period before “by …”.

- - Fix issue #27: Add InboxesApi, related models, tests, examples. by @Ihor-Bilous in https://github.com/railsware/mailtrap-python/pull/40
+ - Fix issue #27: Add InboxesApi, related models, tests, examples by @Ihor-Bilous in https://github.com/railsware/mailtrap-python/pull/40

2-13: Silence markdownlint MD034 by wrapping bare URLs in angle brackets.

Currently flagged across these lines. Example transformation:

- - Potential fix for code scanning alert no. 1: Workflow does not contain permissions by @mklocek in https://github.com/railsware/mailtrap-python/pull/15
+ - Potential fix for code scanning alert no. 1: Workflow does not contain permissions by @mklocek in <https://github.com/railsware/mailtrap-python/pull/15>

Repeat for lines 3–13.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 247c0bc and 615991e.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • pyproject.toml (1 hunks)
🔥 Files not summarized due to errors (1)
  • pyproject.toml: Error: Server error: no LLM provider could handle the message
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CHANGELOG.md

2-2: Bare URL used

(MD034, no-bare-urls)


3-3: Bare URL used

(MD034, no-bare-urls)


4-4: Bare URL used

(MD034, no-bare-urls)


5-5: Bare URL used

(MD034, no-bare-urls)


6-6: Bare URL used

(MD034, no-bare-urls)


7-7: Bare URL used

(MD034, no-bare-urls)


8-8: Bare URL used

(MD034, no-bare-urls)


9-9: Bare URL used

(MD034, no-bare-urls)


10-10: Bare URL used

(MD034, no-bare-urls)


11-11: Bare URL used

(MD034, no-bare-urls)


12-12: Bare URL used

(MD034, no-bare-urls)


13-13: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Test python3.10 on windows-latest
  • GitHub Check: Test python3.13 on windows-latest
🔇 Additional comments (2)
CHANGELOG.md (1)

1-14: Verify version propagation — packaging updated but additional checks required.

  • pyproject.toml (line 3): version = "2.2.0" — packaging metadata updated.
  • CHANGELOG.md (line 1): ## [2.2.0] - 2025-09-18 — changelog updated.
  • setup.cfg / setup.py: not present in repo (fd reported errors).
  • version constants: ripgrep search did not complete ("No files were searched") — verify any version in package init.py or other modules.
  • Release/tagging: confirm the repo's release workflow will create a v2.2.0 tag (setuptools-scm vs manual tagging) and update CI/release docs if needed.
pyproject.toml (1)

3-3: Version bump to 2.2.0 looks good — confirm remaining repo-wide checks

  • Confirmed: pyproject.toml = 2.2.0; CHANGELOG.md has "## [2.2.0] - 2025-09-18"; requirements.txt present; CI includes Python 3.13 (.github/workflows/main.yml).
  • Ambiguous/not fully searched: ripgrep skipped files for the version and 2.1.x scans — re-run without ignores: rg -uu -n '^\s*version\s*=' --glob '!/dist/' ; rg -uu -n '2.1.[0-9]+' --glob '!/dist/'
  • Optional: no py.typed found (OK if not publishing PEP 561 type stubs).

@VladimirTaytor VladimirTaytor merged commit ff0746f into main Sep 19, 2025
34 checks passed
@VladimirTaytor VladimirTaytor deleted the release-v2.2.0 branch September 19, 2025 10:14
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.

3 participants