Skip to content

Commit c6e8f01

Browse files
authored
feat: upgrade guide/docs (#95)
* feat: upgrade guide/docs * fix: remove travis * fix: add view old version docs
1 parent 42b09f6 commit c6e8f01

File tree

3 files changed

+36
-24
lines changed

3 files changed

+36
-24
lines changed

.travis.yml

Lines changed: 0 additions & 22 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
All notable changes to `twilio` will be documented in this file
44

5-
## 1.0.0 - 2016-08-24
5+
## 3.0.0
6+
7+
This is a major release with breaking changes. Please see the upgrading section in the readme for more info.
8+
9+
- Throw exceptions on send failure (with the ability to suppress certain error codes) **BREAKING CHANGE** [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
10+
- Make service provider deferrable [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
11+
- Drop support for Laravel 5.7 and lower **BREAKING CHANGE** [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
12+
- Move config to a dedicated config file **BREAKING CHANGE** [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
13+
- Update Twilio SDK to 6.x [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
14+
- Add "Default To" local debugging support [#90](https://github.com/laravel-notification-channels/twilio/pull/90)
15+
- Switch to Github Actions CI [#91](https://github.com/laravel-notification-channels/twilio/pull/91)
16+
17+
## 2.0.0
18+
19+
- initial 2.x release
20+
21+
## 1.0.0
622

723
- initial release

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
This package makes it easy to send [Twilio notifications](https://documentation.twilio.com/docs) with Laravel 5.5+, 6.x and 7.x
1212

13+
You are viewing the `3.x` documentation. [Click here](https://github.com/laravel-notification-channels/twilio/tree/2.x) to view the `2.x` documentation.
14+
1315
## Contents
1416

1517
- [Installation](#installation)
@@ -31,7 +33,7 @@ You can install the package via composer:
3133
composer require laravel-notification-channels/twilio
3234
```
3335

34-
### Setting up your Twilio account
36+
### Configuration
3537

3638
Add your Twilio Account SID, Auth Token, and From Number (optional) to your `.env`:
3739

@@ -60,6 +62,21 @@ exception codes from [the documentation](https://www.twilio.com/docs/api/errors)
6062
If you want to suppress all errors, you can set the option to `['*']`. The errors will not be logged but notification
6163
failed events will still be emitted.
6264

65+
## Upgrading from 2.x to 3.x
66+
67+
If you're upgrading from version `2.x`, you'll need to make sure that your set environment variables match those above
68+
in the config section. None of the environment variable names have changed, but if you used different keys in your
69+
`services.php` config then you'll need to update them to match the above, or publish the config file and change the
70+
`env` key.
71+
72+
You should also remove the old entry for `twilio` from your `services.php` config, since it's no longer used.
73+
74+
The main breaking change between `2.x` and `3.x` is that failed notification will now throw an exception unless they are
75+
in the list of ignored error codes (publish the config file to edit these).
76+
77+
You can replicate the `2.x` behaviour by setting `'ignored_error_codes' => ['*']`, which will case all exceptions to be
78+
suppressed.
79+
6380
## Usage
6481

6582
Now you can use the channel in your `via()` method inside the notification:
@@ -171,6 +188,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
171188
## Credits
172189

173190
- [Gregorio Hernández Caso](https://github.com/gregoriohc)
191+
- [atymic](https://github.com/atymic)
174192
- [All Contributors](../../contributors)
175193

176194
## License

0 commit comments

Comments
 (0)