Upgrade changelog and add "Notes" section to make it more useful for external integrations.

parent 2511406b
...@@ -7,6 +7,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -7,6 +7,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
### Added ### Added
### Changed ### Changed
- Touched up readme including header and badges. - Touched up readme including header and badges.
- Updated changelog to be more useful for external integrations like [Tidelift] and GitHub releases.
### Deprecated ### Deprecated
### Removed ### Removed
- Abstract methods from `InputMedia` interface, as method annotations didn't work for propagation. - Abstract methods from `InputMedia` interface, as method annotations didn't work for propagation.
...@@ -14,7 +15,9 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -14,7 +15,9 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
### Security ### Security
## [0.58.0] - 2019-06-26 ## [0.58.0] - 2019-06-26
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.58.0-sql-migration] on your database. ### Notes
- [:ledger: View full changelog][0.58.0][:page_with_curl: DB migration script][0.58.0-sql-migration]
- Logging now uses [PSR-3] `LoggerInterface`. Learn more about how to use it here: #964
### Added ### Added
- New funding and support details. (#971) - New funding and support details. (#971)
- Custom issue templates. (#972) - Custom issue templates. (#972)
...@@ -35,13 +38,16 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -35,13 +38,16 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Broken `StickerSet::getStickers()` method. (#969) - Broken `StickerSet::getStickers()` method. (#969)
- Smaller code and docblock fixes. (#973) - Smaller code and docblock fixes. (#973)
### Security ### Security
- Security disclosure managed by Tidelift. (#971) - Security disclosure managed by [Tidelift]. (#971)
- Don't allow a user to call system commands directly. (#970) - Don't allow a user to call system commands directly. (#970)
## [0.57.0] - 2019-06-01 ## [0.57.0] - 2019-06-01
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.57.0-sql-migration] on your database. ### Notes
- [:ledger: View full changelog][0.57.0][:page_with_curl: DB migration script][0.57.0-sql-migration]
- :grey_exclamation: This is a big update and involves a bunch of MySQL database updates, so please *review the changelog carefully*.
### Added ### Added
- New logo! (#954) - New logo! :tada: (#954)
- Bot API 4.2 (Polls). (#948) - Bot API 4.2 (Polls). (#948)
- `getIsMember()` method to `ChatMember` entity. (#948) - `getIsMember()` method to `ChatMember` entity. (#948)
- `getForwardSenderName()` method to `Message` entity. (#948) - `getForwardSenderName()` method to `Message` entity. (#948)
...@@ -52,8 +58,11 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -52,8 +58,11 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Missing DB table name specifier in `/cleanup` command. (#947) - Missing DB table name specifier in `/cleanup` command. (#947)
## [0.56.0] - 2019-04-15 ## [0.56.0] - 2019-04-15
### Notes
- [:ledger: View full changelog][0.56.0][:page_with_curl: DB migration script][0.56.0-sql-migration]
- :grey_exclamation: This is a big update, so please *review the changelog carefully*!
### Added ### Added
- Helper for sending `InputMedia` objects using `Request::sendMediaGroup()` and `Request::editMediaMessage()` methods. (#934) - Helper for sending `InputMedia` objects using `Request::sendMediaGroup()` and `Request::editMediaMessage()` methods.
- Allow passing absolute file path for InputFile fields, instead of `Request::encodeFile($path)`. (#934) - Allow passing absolute file path for InputFile fields, instead of `Request::encodeFile($path)`. (#934)
### Changed ### Changed
- All Message field types dynamically search for an existing Command class that can handle them. (#940) - All Message field types dynamically search for an existing Command class that can handle them. (#940)
...@@ -67,13 +76,16 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -67,13 +76,16 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- PHPCS: static before visibility declaration. (#945) - PHPCS: static before visibility declaration. (#945)
## [0.55.1] - 2019-01-06 ## [0.55.1] - 2019-01-06
### Notes
- [:ledger: View full changelog][0.55.1]
### Added ### Added
- Add missing `Request::editMessageMedia()` and `CallbackQuery::getChatInstance()` methods. (#916) - Add missing `Request::editMessageMedia()` and `CallbackQuery::getChatInstance()` methods. (#916)
### Fixed ### Fixed
- Return correct message type. (#913) - Return correct message type. (#913)
## [0.55.0] - 2018-12-20 ## [0.55.0] - 2018-12-20
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.55.0-sql-migration] on your database. ### Notes
- [:ledger: View full changelog][0.55.0][:page_with_curl: DB migration script][0.55.0-sql-migration]
### Added ### Added
- Bot API 4.0 and 4.1 (Telegram Passport) (#870, #871) - Bot API 4.0 and 4.1 (Telegram Passport) (#870, #871)
- Test PHP 7.3 with Travis. (#903) - Test PHP 7.3 with Travis. (#903)
...@@ -83,11 +95,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -83,11 +95,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Added missing `video_note` to `Message` types. - Added missing `video_note` to `Message` types.
## [0.54.1] - 2018-10-23 ## [0.54.1] - 2018-10-23
### Notes
- [:ledger: View full changelog][0.54.1]
### Fixed ### Fixed
- `sendToActiveChats` now works correctly for any valid Request action. (#898) - `sendToActiveChats` now works correctly for any valid Request action. (#898)
## [0.54.0] - 2018-07-21 ## [0.54.0] - 2018-07-21
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.54.0-sql-migration] on your database. ### Notes
- [:ledger: View full changelog][0.54.0][:page_with_curl: DB migration script][0.54.0-sql-migration]
### Added ### Added
- `ChatAction` class to simplify chat action selection. (#859) - `ChatAction` class to simplify chat action selection. (#859)
- Telegram Games platform! (#732) - Telegram Games platform! (#732)
...@@ -100,7 +115,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -100,7 +115,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Response from `getStickerSet`. (#838) - Response from `getStickerSet`. (#838)
## [0.53.0] - 2018-04-01 ## [0.53.0] - 2018-04-01
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.53.0-sql-migration] on your database. ### Notes
- [:ledger: View full changelog][0.53.0][:page_with_curl: DB migration script][0.53.0-sql-migration]
### Added ### Added
- Implemented new changes for Bot API 3.6 (streamable InputMediaVideo, connected website). (#799) - Implemented new changes for Bot API 3.6 (streamable InputMediaVideo, connected website). (#799)
- `Telegram::getLastUpdateId()` method, returns ID of the last update that was processed. (#767) - `Telegram::getLastUpdateId()` method, returns ID of the last update that was processed. (#767)
...@@ -115,17 +131,22 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -115,17 +131,22 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Send messages correctly via `/sendtochannel`. (#803) - Send messages correctly via `/sendtochannel`. (#803)
## [0.52.0] - 2018-01-07 ## [0.52.0] - 2018-01-07
### Notes
- [:ledger: View full changelog][0.52.0]
### Fixed ### Fixed
- Entity relations and wrong types for payments. (#731) - Entity relations and wrong types for payments. (#731)
- Allow empty string for `switch_inline_query` and `switch_inline_query_current_chat` (InlineKeyboardButton). (#736) - Allow empty string for `switch_inline_query` and `switch_inline_query_current_chat` (InlineKeyboardButton). (#736)
- Fix empty date entry for User and Chat entities, using the current timestamp instead. (#738) - Fix empty date entry for User and Chat entities, using the current timestamp instead. (#738)
## [0.51.0] - 2017-12-05 ## [0.51.0] - 2017-12-05
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.51.0-sql-migration] on your database. ### Notes
- [:ledger: View full changelog][0.51.0][:page_with_curl: DB migration script][0.51.0-sql-migration]
### Added ### Added
- Implemented new changes for Bot API 3.5 (InputMedia, MediaGroup). (#718) - Implemented new changes for Bot API 3.5 (InputMedia, MediaGroup). (#718)
## [0.50.0] - 2017-10-17 ## [0.50.0] - 2017-10-17
### Notes
- [:ledger: View full changelog][0.50.0]
### Added ### Added
- Finish implementing payments, adding all missing type checks and docblock methods. (#647) - Finish implementing payments, adding all missing type checks and docblock methods. (#647)
- Implemented new changes for Bot API 3.4 (Live Locations). (#675) - Implemented new changes for Bot API 3.4 (Live Locations). (#675)
...@@ -137,6 +158,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -137,6 +158,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Check inline keyboard button parameter value correctly. (#672) - Check inline keyboard button parameter value correctly. (#672)
## [0.49.0] - 2017-09-17 ## [0.49.0] - 2017-09-17
### Notes
- [:ledger: View full changelog][0.49.0]
### Added ### Added
- Donation section and links in readme. - Donation section and links in readme.
- Missing payment methods in `Request` class. - Missing payment methods in `Request` class.
...@@ -148,7 +171,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -148,7 +171,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Channel selection when using `DB::selectChats()`. - Channel selection when using `DB::selectChats()`.
## [0.48.0] - 2017-08-26 ## [0.48.0] - 2017-08-26
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.48.0-sql-migration] on your database. ### Notes
- [:ledger: View full changelog][0.48.0][:page_with_curl: DB migration script][0.48.0-sql-migration]
### Added ### Added
- New entities, methods, update types and inline keyboard button for Payments (Bot API 3.0). - New entities, methods, update types and inline keyboard button for Payments (Bot API 3.0).
- Add new methods, fields and objects for working with stickers (Bot API 3.2). - Add new methods, fields and objects for working with stickers (Bot API 3.2).
...@@ -160,12 +184,16 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -160,12 +184,16 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Correctly save `reply_to_message` to DB. - Correctly save `reply_to_message` to DB.
## [0.47.1] - 2017-08-06 ## [0.47.1] - 2017-08-06
### Notes
- [:ledger: View full changelog][0.47.1]
### Added ### Added
- Linked version numbers in changelog for easy verification of code changes. - Linked version numbers in changelog for easy verification of code changes.
### Fixed ### Fixed
- Private-only commands work with edited messages now too. - Private-only commands work with edited messages now too.
## [0.47.0] - 2017-08-06 [YANKED] ## [0.47.0] - 2017-08-06 [YANKED]
### Notes
- [:ledger: View full changelog][0.47.0]
### Changed ### Changed
- Updated readme to latest state of 0.47.0. - Updated readme to latest state of 0.47.0.
### Fixed ### Fixed
...@@ -175,6 +203,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -175,6 +203,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- [:exclamation:][0.47.0-bc-private-only-admin-commands] New command parameter `$private_only` to enforce usage in private chats only (set by default for Admin commands). - [:exclamation:][0.47.0-bc-private-only-admin-commands] New command parameter `$private_only` to enforce usage in private chats only (set by default for Admin commands).
## [0.46.0] - 2017-07-15 ## [0.46.0] - 2017-07-15
### Notes
- [:ledger: View full changelog][0.46.0]
### Added ### Added
- Callbacks can be added to be executed when callback queries are called. - Callbacks can be added to be executed when callback queries are called.
- New Bot API 3.1 changes (#550). - New Bot API 3.1 changes (#550).
...@@ -183,7 +213,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -183,7 +213,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- [:exclamation:][0.46.0-bc-request-class-refactor] Big refactor of the `Request` class, removing most custom method implementations. - [:exclamation:][0.46.0-bc-request-class-refactor] Big refactor of the `Request` class, removing most custom method implementations.
## [0.45.0] - 2017-06-25 ## [0.45.0] - 2017-06-25
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.45.0-sql-migration] on your database. ### Notes
- [:ledger: View full changelog][0.45.0][:page_with_curl: DB migration script][0.45.0-sql-migration]
### Added ### Added
- Documents can be sent by providing its contents via Psr7 stream (as opposed to passing a file path). - Documents can be sent by providing its contents via Psr7 stream (as opposed to passing a file path).
- Allow setting a custom Guzzle HTTP Client for requests (#511). - Allow setting a custom Guzzle HTTP Client for requests (#511).
...@@ -204,10 +235,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -204,10 +235,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Request limiter has been fixed to correctly support channels. - Request limiter has been fixed to correctly support channels.
## [0.44.1] - 2017-04-25 ## [0.44.1] - 2017-04-25
### Notes
- [:ledger: View full changelog][0.44.1]
### Fixed ### Fixed
- Erroneous exception when using webhook without a database connection. - Erroneous exception when using webhook without a database connection.
## [0.44.0] - 2017-04-25 ## [0.44.0] - 2017-04-25
### Notes
- [:ledger: View full changelog][0.44.0]
### Added ### Added
- Proper standalone `scrutinizer.yml` config. - Proper standalone `scrutinizer.yml` config.
- Human-readable `last_error_date_string` for debug command. - Human-readable `last_error_date_string` for debug command.
...@@ -219,6 +254,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -219,6 +254,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- [:exclamation:][0.44.0-bc-update-content-type] Format of Update content type using `$update->getUpdateContent()`. - [:exclamation:][0.44.0-bc-update-content-type] Format of Update content type using `$update->getUpdateContent()`.
## [0.43.0] - 2017-04-17 ## [0.43.0] - 2017-04-17
### Notes
- [:ledger: View full changelog][0.43.0]
### Added ### Added
- Travis CI webhook for Support Bot. - Travis CI webhook for Support Bot.
- Interval for request limiter. - Interval for request limiter.
...@@ -232,6 +269,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -232,6 +269,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Prevent handling the same Telegram updates multiple times, throw exception instead. - Prevent handling the same Telegram updates multiple times, throw exception instead.
## [0.42.0] - 2017-04-09 ## [0.42.0] - 2017-04-09
### Notes
- [:ledger: View full changelog][0.42.0]
### Added ### Added
- Added `getBotId()` to directly access bot ID. - Added `getBotId()` to directly access bot ID.
### Changed ### Changed
...@@ -242,22 +281,30 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -242,22 +281,30 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Tests are more reliable now, using a properly formatted API key. - Tests are more reliable now, using a properly formatted API key.
## [0.41.0] - 2017-03-25 ## [0.41.0] - 2017-03-25
### Notes
- [:ledger: View full changelog][0.41.0]
### Added ### Added
- `$show_in_help` attribute for commands, to set if it should be displayed in the `/help` command. - `$show_in_help` attribute for commands, to set if it should be displayed in the `/help` command.
- Link to new Telegram group: `https://telegram.me/PHP_Telegram_Bot_Support` - Link to new Telegram group: `https://telegram.me/PHP_Telegram_Bot_Support`
- Introduce change log. - Introduce change log.
## [0.40.1] - 2017-03-07 ## [0.40.1] - 2017-03-07
### Notes
- [:ledger: View full changelog][0.40.1]
### Fixed ### Fixed
- Infinite message loop, caused by incorrect Entity variable. - Infinite message loop, caused by incorrect Entity variable.
## [0.40.0] - 2017-02-20 ## [0.40.0] - 2017-02-20
### Notes
- [:ledger: View full changelog][0.40.0]
### Added ### Added
- Request limiter for incoming requests. - Request limiter for incoming requests.
### Fixed ### Fixed
- Faulty formatting in logger. - Faulty formatting in logger.
## [0.39.0] - 2017-01-20 ## [0.39.0] - 2017-01-20
### Notes
- [:ledger: View full changelog][0.39.0]
### Added ### Added
- Newest bot API changes. - Newest bot API changes.
- Allow direct access to PDO object (`DB::getPdo()`). - Allow direct access to PDO object (`DB::getPdo()`).
...@@ -270,10 +317,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -270,10 +317,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Various bugs and recommendations by Scrutinizer. - Various bugs and recommendations by Scrutinizer.
## [0.38.1] - 2016-12-25 ## [0.38.1] - 2016-12-25
### Notes
- [:ledger: View full changelog][0.38.1]
### Fixed ### Fixed
- Usage of self-signed certificates in conjunction with the new `allowed_updates` webhook parameter. - Usage of self-signed certificates in conjunction with the new `allowed_updates` webhook parameter.
## [0.38.0] - 2016-12-25 ## [0.38.0] - 2016-12-25
### Notes
- [:ledger: View full changelog][0.38.0]
### Added ### Added
- New `switch_inline_query_current_chat` option for inline keyboard. - New `switch_inline_query_current_chat` option for inline keyboard.
- Support for `channel_post` and `edited_channel_post`. - Support for `channel_post` and `edited_channel_post`.
...@@ -282,17 +333,21 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -282,17 +333,21 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
- Update WebhookInfo entity and `setWebhook` to allow passing of new arguments. - Update WebhookInfo entity and `setWebhook` to allow passing of new arguments.
## [0.37.1] - 2016-12-24 ## [0.37.1] - 2016-12-24
### Notes
- [:ledger: View full changelog][0.37.1]
### Fixed ### Fixed
- Keyboards that are built without using the KeyboardButton objects. - Keyboards that are built without using the KeyboardButton objects.
- Commands that are called via `/command@botname` by correctly passing them the bot name. - Commands that are called via `/command@botname` by correctly passing them the bot name.
## [0.37.0] - 2016-12-13 ## [0.37.0] - 2016-12-13
### Notes
- [:ledger: View full changelog][0.37.0]
### Changed ### Changed
- Logging improvements to Botan integration. - Logging improvements to Botan integration.
### Deprecated ### Deprecated
- Move `hideKeyboard` to `removeKeyboard`. - Move `hideKeyboard` to `removeKeyboard`.
[0.58.0-sql-migration]: https://github.com/php-telegram-bot/core/tree/develop/utils/db-schema-update/0.57.0-0.58.0.sql [0.58.0-sql-migration]: https://github.com/php-telegram-bot/core/tree/master/utils/db-schema-update/0.57.0-0.58.0.sql
[0.58.0-bc-return-value-of-empty-entity-properties]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#return-value-of-empty-entity-properties [0.58.0-bc-return-value-of-empty-entity-properties]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#return-value-of-empty-entity-properties
[0.58.0-bc-startcommand-is-now-a-usercommand]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#startcommand-is-now-a-usercommand [0.58.0-bc-startcommand-is-now-a-usercommand]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#startcommand-is-now-a-usercommand
[0.57.0-sql-migration]: https://github.com/php-telegram-bot/core/tree/master/utils/db-schema-update/0.56.0-0.57.0.sql [0.57.0-sql-migration]: https://github.com/php-telegram-bot/core/tree/master/utils/db-schema-update/0.56.0-0.57.0.sql
...@@ -314,6 +369,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c ...@@ -314,6 +369,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
[0.44.0-bc-update-content-type]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#update-getupdatecontent [0.44.0-bc-update-content-type]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#update-getupdatecontent
[example-bot]: https://github.com/php-telegram-bot/example-bot [example-bot]: https://github.com/php-telegram-bot/example-bot
[PSR-3]: https://www.php-fig.org/psr/psr-3 [PSR-3]: https://www.php-fig.org/psr/psr-3
[Tidelift]: https://tidelift.com/subscription/pkg/packagist-longman-telegram-bot?utm_source=packagist-longman-telegram-bot&utm_medium=referral&utm_campaign=changelog
[Unreleased]: https://github.com/php-telegram-bot/core/compare/master...develop [Unreleased]: https://github.com/php-telegram-bot/core/compare/master...develop
[0.58.0]: https://github.com/php-telegram-bot/core/compare/0.57.0...0.58.0 [0.58.0]: https://github.com/php-telegram-bot/core/compare/0.57.0...0.58.0
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment