Release version 2.4.0

[i7an]

Motivation

Release version 2.4.0

Changes

• Release version 2.4.0

How to test

• Check for regressions
• Test new APIs

Images and GIFs

N/A

Summary by CodeRabbit

• New Features

  • Introduced Email Templates API, Contacts API, Contact Fields API, Contact Lists API, and Batch Sending functionality.

• Deprecations

  • The previous Mailtrap::Mail::FromTemplate class is now deprecated in favor of the new Mailtrap::Mail.from_template method.

• Chores

  • Updated version to 2.4.0 and revised the changelog to reflect new features and deprecations.

[coderabbitai]

Walkthrough

The changes update the project version to 2.4.0 in both the changelog and the version file. The changelog documents new APIs (Email Templates, Contacts, Contact Fields, Contact Lists, Batch Sending) and notes the deprecation of a class in favor of a new method. No code changes beyond version bumping are present.

Changes

Cohort / File(s)	Change Summary
Changelog Update CHANGELOG.md	Added release notes for version 2.4.0, documenting new APIs and a deprecation notice.
Version Bump lib/mailtrap/version.rb	Updated the VERSION constant from '2.3.0' to '2.4.0'.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A hop and a skip, a version anew,
2.4.0 is here—so much to do!
New APIs bloom, old ways retire,
The changelog’s fresh, the code aspires.
With bunny paws, we leap ahead,
To brighter builds and bugs unfed! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch release/2.4.0

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

CHANGELOG.md (1)

1-9: Minor wording consistency nit
Previous entries use American English (“favor” is more common in the codebase), while the new line uses “favour”. Aligning the spelling keeps the changelog stylistically uniform.

- - Deprecate `Mailtrap::Mail::FromTemplate` in favour of `Mailtrap::Mail.from_template`
+ - Deprecate `Mailtrap::Mail::FromTemplate` in favor of `Mailtrap::Mail.from_template`

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 022fa3b and 6beed46.

⛔ Files ignored due to path filters (1)

• Gemfile.lock is excluded by !**/*.lock

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• lib/mailtrap/version.rb (1 hunks)

⏰ 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). (1)

• GitHub Check: Analyze (ruby)

🔇 Additional comments (1)

lib/mailtrap/version.rb (1)

3-5: Version constant correctly bumped to 2.4.0
No further action needed.