Skip to content

Commit 1538c11

Browse files
Document ruby 2.6.0 bug
1 parent d05f5b7 commit 1538c11

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

TROUBLESHOOTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ If you can't find a solution below, please open an [issue](https://github.com/se
99
* [Continue Using v2](#v2)
1010
* [Testing v3 /mail/send Calls Directly](#testing)
1111
* [Error Messages](#error)
12-
* [Versions](#versions)
12+
* [Versioning](#versioning)
1313
* [Environment Variables and Your SendGrid API Key](#environment)
1414
* [Using the Package Manager](#package-manager)
1515
* [Rails Specifics](#rails-specifics)
16+
* [Ruby Versions](#ruby-versions)
1617
* [Viewing the Request Body](#request-body)
1718

1819
<a name="migrating"></a>
@@ -67,8 +68,8 @@ rescue Exception => e
6768
end
6869
```
6970

70-
<a name="versions"></a>
71-
## Versions
71+
<a name="versioning"></a>
72+
## Versioning
7273

7374
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/sendgrid-ruby/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases) section.
7475

@@ -119,6 +120,11 @@ gem install sendgrid-ruby -v X.X.X
119120

120121
- Possibility of a namespace collision between the sendgrid class `Email` and your own defined `Email` class. To avoid these issues, you can skip the `include SendGrid` line and use the `SendGrid::` prefix for Email. Please see this [SO answer](https://stackoverflow.com/questions/41508464/rails-model-name-conflict-with-included-gem?noredirect=1#comment70223099_41508464) for specifics.
121122

123+
<a name="ruby-versions"></a>
124+
## Ruby Versions
125+
126+
This SDK [does not work with ruby version 2.6.0](https://github.com/sendgrid/sendgrid-ruby/issues/378) because of [this bug](https://bugs.ruby-lang.org/issues/15468). Please use any other [supported version](https://github.com/sendgrid/sendgrid-ruby#prerequisites).
127+
122128
<a name="request-body"></a>
123129
## Viewing the Request Body
124130

0 commit comments

Comments
 (0)