Skip to content

Add yard dependencies #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
i7an merged 2 commits into from
Feb 3, 2026
Merged

Add yard dependencies #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
005583a
Add yard dependencies
i7an Jan 29, 2026
c140053
Prevent duplicate workflow runs
i7an Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: Ruby

on: [push, pull_request]
on:
push:
branches: [main]
pull_request:

jobs:
build:
Expand Down
3 changes: 3 additions & 0 deletions Gemfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ gem 'appraisal'
gem 'irb'
gem 'mail'
gem 'net-smtp'
gem 'rack'
gem 'rackup'
gem 'rake', '~> 13.3'
gem 'rdoc', '~> 7.1.0'
gem 'rspec', '~> 3'
Expand All @@ -17,4 +19,5 @@ gem 'rubocop-rake', require: false
gem 'rubocop-rspec', require: false
gem 'vcr'
gem 'webmock'
gem 'webrick'
gem 'yard', '~> 0.9'
7 changes: 7 additions & 0 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ GEM
stringio
public_suffix (7.0.2)
racc (1.8.1)
rack (3.2.4)
rackup (2.3.1)
rack (>= 3)
rainbow (3.1.1)
rake (13.3.1)
rdoc (7.1.0)
Expand Down Expand Up @@ -120,6 +123,7 @@ GEM
addressable (>= 2.8.0)
crack (>= 0.3.2)
hashdiff (>= 0.4.0, < 2.0.0)
webrick (1.9.2)
yard (0.9.38)

PLATFORMS
Expand All @@ -131,6 +135,8 @@ DEPENDENCIES
mail
mailtrap!
net-smtp
rack
rackup
rake (~> 13.3)
rdoc (~> 7.1.0)
rspec (~> 3)
Expand All @@ -140,6 +146,7 @@ DEPENDENCIES
rubocop-rspec
vcr
webmock
webrick
yard (~> 0.9)

BUNDLED WITH
Expand Down
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,15 +204,24 @@ Bug reports and pull requests are welcome on [GitHub](https://github.com/railswa

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake spec` to run the tests. You can also run `bin/console` for an interactive
prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`.

To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
To release a new version, update the version number in `version.rb`, and then
run `bundle exec rake release`, which will create a git tag for the version,
push git commits and the created tag, and push the `.gem` file to
[rubygems.org](https://rubygems.org).

To run the documentation server, first generate the documentation with
`yard doc`, then run `yard server`.

All contributions are required to have rspec tests covering its functionality.

Please be sure to update [README](README.md) with new examples and features when applicable.
Please be sure to update [README](README.md) with new examples and features
when applicable.

## License

Expand All @@ -224,4 +233,4 @@ Everyone interacting in the Mailtrap project's codebases, issue trackers, chat r

## Compatibility with previous releases

Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package.
Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package.
Copy link

@coderabbitai coderabbitai bot Jan 29, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Minor wording polish.
Line 236: consider replacing “completely” with “entirely” or dropping the adverb.

✍️ Suggested edit 
-Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [`@vchin`](https://github.com/vchin). Package version 3 is a completely new package. 
+Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [`@vchin`](https://github.com/vchin). Package version 3 is an entirely new package.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package.
Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [`@vchin`](https://github.com/vchin). Package version 3 is an entirely new package.
🧰 Tools
🪛 LanguageTool

[style] ~236-~236: Consider using a different adverb to strengthen your wording.
Context: ...github.com/vchin). Package version 3 is a completely new package.

(COMPLETELY_ENTIRELY)

🤖 Prompt for AI Agents 
In `@README.md` at line 236, The sentence starting "Versions of this package up to
2.0.2 were an unofficial client..." uses the adverb "completely" awkwardly; edit
that sentence to replace "completely" with "entirely" or remove the adverb
(e.g., "Package version 3 is an entirely new package." or "Package version 3 is
a new package.") to improve wording and clarity.