diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 07d08be..2e20365 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,6 +1,9 @@ name: Ruby -on: [push, pull_request] +on: + push: + branches: [main] + pull_request: jobs: build: diff --git a/Gemfile b/Gemfile index d310548..f404e65 100644 --- a/Gemfile +++ b/Gemfile @@ -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' @@ -17,4 +19,5 @@ gem 'rubocop-rake', require: false gem 'rubocop-rspec', require: false gem 'vcr' gem 'webmock' +gem 'webrick' gem 'yard', '~> 0.9' diff --git a/Gemfile.lock b/Gemfile.lock index 9ff559e..915d212 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -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) @@ -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 @@ -131,6 +135,8 @@ DEPENDENCIES mail mailtrap! net-smtp + rack + rackup rake (~> 13.3) rdoc (~> 7.1.0) rspec (~> 3) @@ -140,6 +146,7 @@ DEPENDENCIES rubocop-rspec vcr webmock + webrick yard (~> 0.9) BUNDLED WITH diff --git a/README.md b/README.md index 01e7b05..b92b8c1 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. \ No newline at end of file +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.