Skip to content

Commit f85bb01

Browse files
noplanmannoplanman
authored
Merge pull request #981 from noplanman/update_readme_changelog
Update README and CHANGELOG
2 parents d5b9307 + ddf5729 commit f85bb01

File tree

3 files changed

+153
-88
lines changed

3 files changed

+153
-88
lines changed

‎CHANGELOG.md

Lines changed: 69 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,18 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
66
## [Unreleased]
77
### Added
88
### Changed
9+
- Touched up readme including header and badges.
10+
- Updated changelog to be more useful for external integrations like [Tidelift] and GitHub releases.
911
### Deprecated
1012
### Removed
1113
- Abstract methods from `InputMedia` interface, as method annotations didn't work for propagation.
1214
### Fixed
1315
### Security
1416

1517
## [0.58.0] - 2019-06-26
16-
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.58.0-sql-migration] on your database.
18+
### Notes
19+
- [:ledger: View full changelog][0.58.0] ∙ [:page_with_curl: DB migration script][0.58.0-sql-migration]
20+
- Logging now uses [PSR-3] `LoggerInterface`. Learn more about how to use it here: #964
1721
### Added
1822
- New funding and support details. (#971)
1923
- Custom issue templates. (#972)
@@ -34,13 +38,16 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
3438
- Broken `StickerSet::getStickers()` method. (#969)
3539
- Smaller code and docblock fixes. (#973)
3640
### Security
37-
- Security disclosure managed by Tidelift. (#971)
41+
- Security disclosure managed by [Tidelift]. (#971)
3842
- Don't allow a user to call system commands directly. (#970)
3943

4044
## [0.57.0] - 2019-06-01
41-
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.57.0-sql-migration] on your database.
45+
### Notes
46+
- [:ledger: View full changelog][0.57.0] ∙ [:page_with_curl: DB migration script][0.57.0-sql-migration]
47+
- :grey_exclamation: This is a big update and involves a bunch of MySQL database updates, so please *review the changelog carefully*.
48+
4249
### Added
43-
- New logo! (#954)
50+
- New logo! :tada: (#954)
4451
- Bot API 4.2 (Polls). (#948)
4552
- `getIsMember()` method to `ChatMember` entity. (#948)
4653
- `getForwardSenderName()` method to `Message` entity. (#948)
@@ -51,8 +58,11 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
5158
- Missing DB table name specifier in `/cleanup` command. (#947)
5259

5360
## [0.56.0] - 2019-04-15
61+
### Notes
62+
- [:ledger: View full changelog][0.56.0] ∙ [:page_with_curl: DB migration script][0.56.0-sql-migration]
63+
- :grey_exclamation: This is a big update, so please *review the changelog carefully*!
5464
### Added
55-
- Helper for sending `InputMedia` objects using `Request::sendMediaGroup()` and `Request::editMediaMessage()` methods. (#934)
65+
- Helper for sending `InputMedia` objects using `Request::sendMediaGroup()` and `Request::editMediaMessage()` methods.
5666
- Allow passing absolute file path for InputFile fields, instead of `Request::encodeFile($path)`. (#934)
5767
### Changed
5868
- All Message field types dynamically search for an existing Command class that can handle them. (#940)
@@ -66,13 +76,16 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
6676
- PHPCS: static before visibility declaration. (#945)
6777

6878
## [0.55.1] - 2019-01-06
79+
### Notes
80+
- [:ledger: View full changelog][0.55.1]
6981
### Added
7082
- Add missing `Request::editMessageMedia()` and `CallbackQuery::getChatInstance()` methods. (#916)
7183
### Fixed
7284
- Return correct message type. (#913)
7385

7486
## [0.55.0] - 2018-12-20
75-
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.55.0-sql-migration] on your database.
87+
### Notes
88+
- [:ledger: View full changelog][0.55.0] ∙ [:page_with_curl: DB migration script][0.55.0-sql-migration]
7689
### Added
7790
- Bot API 4.0 and 4.1 (Telegram Passport) (#870, #871)
7891
- Test PHP 7.3 with Travis. (#903)
@@ -82,11 +95,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
8295
- Added missing `video_note` to `Message` types.
8396

8497
## [0.54.1] - 2018-10-23
98+
### Notes
99+
- [:ledger: View full changelog][0.54.1]
85100
### Fixed
86101
- `sendToActiveChats` now works correctly for any valid Request action. (#898)
87102

88103
## [0.54.0] - 2018-07-21
89-
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.54.0-sql-migration] on your database.
104+
### Notes
105+
- [:ledger: View full changelog][0.54.0] ∙ [:page_with_curl: DB migration script][0.54.0-sql-migration]
90106
### Added
91107
- `ChatAction` class to simplify chat action selection. (#859)
92108
- Telegram Games platform! (#732)
@@ -99,7 +115,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
99115
- Response from `getStickerSet`. (#838)
100116

101117
## [0.53.0] - 2018-04-01
102-
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.53.0-sql-migration] on your database.
118+
### Notes
119+
- [:ledger: View full changelog][0.53.0] ∙ [:page_with_curl: DB migration script][0.53.0-sql-migration]
103120
### Added
104121
- Implemented new changes for Bot API 3.6 (streamable InputMediaVideo, connected website). (#799)
105122
- `Telegram::getLastUpdateId()` method, returns ID of the last update that was processed. (#767)
@@ -114,17 +131,22 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
114131
- Send messages correctly via `/sendtochannel`. (#803)
115132

116133
## [0.52.0] - 2018-01-07
134+
### Notes
135+
- [:ledger: View full changelog][0.52.0]
117136
### Fixed
118137
- Entity relations and wrong types for payments. (#731)
119138
- Allow empty string for `switch_inline_query` and `switch_inline_query_current_chat` (InlineKeyboardButton). (#736)
120139
- Fix empty date entry for User and Chat entities, using the current timestamp instead. (#738)
121140

122141
## [0.51.0] - 2017-12-05
123-
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.51.0-sql-migration] on your database.
142+
### Notes
143+
- [:ledger: View full changelog][0.51.0] ∙ [:page_with_curl: DB migration script][0.51.0-sql-migration]
124144
### Added
125145
- Implemented new changes for Bot API 3.5 (InputMedia, MediaGroup). (#718)
126146

127147
## [0.50.0] - 2017-10-17
148+
### Notes
149+
- [:ledger: View full changelog][0.50.0]
128150
### Added
129151
- Finish implementing payments, adding all missing type checks and docblock methods. (#647)
130152
- Implemented new changes for Bot API 3.4 (Live Locations). (#675)
@@ -136,6 +158,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
136158
- Check inline keyboard button parameter value correctly. (#672)
137159

138160
## [0.49.0] - 2017-09-17
161+
### Notes
162+
- [:ledger: View full changelog][0.49.0]
139163
### Added
140164
- Donation section and links in readme.
141165
- Missing payment methods in `Request` class.
@@ -147,7 +171,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
147171
- Channel selection when using `DB::selectChats()`.
148172

149173
## [0.48.0] - 2017-08-26
150-
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.48.0-sql-migration] on your database.
174+
### Notes
175+
- [:ledger: View full changelog][0.48.0] ∙ [:page_with_curl: DB migration script][0.48.0-sql-migration]
151176
### Added
152177
- New entities, methods, update types and inline keyboard button for Payments (Bot API 3.0).
153178
- Add new methods, fields and objects for working with stickers (Bot API 3.2).
@@ -159,12 +184,16 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
159184
- Correctly save `reply_to_message` to DB.
160185

161186
## [0.47.1] - 2017-08-06
187+
### Notes
188+
- [:ledger: View full changelog][0.47.1]
162189
### Added
163190
- Linked version numbers in changelog for easy verification of code changes.
164191
### Fixed
165192
- Private-only commands work with edited messages now too.
166193

167194
## [0.47.0] - 2017-08-06 [YANKED]
195+
### Notes
196+
- [:ledger: View full changelog][0.47.0]
168197
### Changed
169198
- Updated readme to latest state of 0.47.0.
170199
### Fixed
@@ -174,6 +203,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
174203
- [: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).
175204

176205
## [0.46.0] - 2017-07-15
206+
### Notes
207+
- [:ledger: View full changelog][0.46.0]
177208
### Added
178209
- Callbacks can be added to be executed when callback queries are called.
179210
- New Bot API 3.1 changes (#550).
@@ -182,7 +213,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
182213
- [:exclamation:][0.46.0-bc-request-class-refactor] Big refactor of the `Request` class, removing most custom method implementations.
183214

184215
## [0.45.0] - 2017-06-25
185-
:exclamation: After updating to this version, you will need to execute the [SQL migration script][0.45.0-sql-migration] on your database.
216+
### Notes
217+
- [:ledger: View full changelog][0.45.0] ∙ [:page_with_curl: DB migration script][0.45.0-sql-migration]
186218
### Added
187219
- Documents can be sent by providing its contents via Psr7 stream (as opposed to passing a file path).
188220
- Allow setting a custom Guzzle HTTP Client for requests (#511).
@@ -203,10 +235,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
203235
- Request limiter has been fixed to correctly support channels.
204236

205237
## [0.44.1] - 2017-04-25
238+
### Notes
239+
- [:ledger: View full changelog][0.44.1]
206240
### Fixed
207241
- Erroneous exception when using webhook without a database connection.
208242

209243
## [0.44.0] - 2017-04-25
244+
### Notes
245+
- [:ledger: View full changelog][0.44.0]
210246
### Added
211247
- Proper standalone `scrutinizer.yml` config.
212248
- Human-readable `last_error_date_string` for debug command.
@@ -218,6 +254,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
218254
- [:exclamation:][0.44.0-bc-update-content-type] Format of Update content type using `$update->getUpdateContent()`.
219255

220256
## [0.43.0] - 2017-04-17
257+
### Notes
258+
- [:ledger: View full changelog][0.43.0]
221259
### Added
222260
- Travis CI webhook for Support Bot.
223261
- Interval for request limiter.
@@ -231,6 +269,8 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
231269
- Prevent handling the same Telegram updates multiple times, throw exception instead.
232270

233271
## [0.42.0] - 2017-04-09
272+
### Notes
273+
- [:ledger: View full changelog][0.42.0]
234274
### Added
235275
- Added `getBotId()` to directly access bot ID.
236276
### Changed
@@ -241,22 +281,30 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
241281
- Tests are more reliable now, using a properly formatted API key.
242282

243283
## [0.41.0] - 2017-03-25
284+
### Notes
285+
- [:ledger: View full changelog][0.41.0]
244286
### Added
245287
- `$show_in_help` attribute for commands, to set if it should be displayed in the `/help` command.
246288
- Link to new Telegram group: `https://telegram.me/PHP_Telegram_Bot_Support`
247289
- Introduce change log.
248290

249291
## [0.40.1] - 2017-03-07
292+
### Notes
293+
- [:ledger: View full changelog][0.40.1]
250294
### Fixed
251295
- Infinite message loop, caused by incorrect Entity variable.
252296

253297
## [0.40.0] - 2017-02-20
298+
### Notes
299+
- [:ledger: View full changelog][0.40.0]
254300
### Added
255301
- Request limiter for incoming requests.
256302
### Fixed
257303
- Faulty formatting in logger.
258304

259305
## [0.39.0] - 2017-01-20
306+
### Notes
307+
- [:ledger: View full changelog][0.39.0]
260308
### Added
261309
- Newest bot API changes.
262310
- Allow direct access to PDO object (`DB::getPdo()`).
@@ -269,10 +317,14 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
269317
- Various bugs and recommendations by Scrutinizer.
270318

271319
## [0.38.1] - 2016-12-25
320+
### Notes
321+
- [:ledger: View full changelog][0.38.1]
272322
### Fixed
273323
- Usage of self-signed certificates in conjunction with the new `allowed_updates` webhook parameter.
274324

275325
## [0.38.0] - 2016-12-25
326+
### Notes
327+
- [:ledger: View full changelog][0.38.0]
276328
### Added
277329
- New `switch_inline_query_current_chat` option for inline keyboard.
278330
- Support for `channel_post` and `edited_channel_post`.
@@ -281,17 +333,21 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
281333
- Update WebhookInfo entity and `setWebhook` to allow passing of new arguments.
282334

283335
## [0.37.1] - 2016-12-24
336+
### Notes
337+
- [:ledger: View full changelog][0.37.1]
284338
### Fixed
285339
- Keyboards that are built without using the KeyboardButton objects.
286340
- Commands that are called via `/command@botname` by correctly passing them the bot name.
287341

288342
## [0.37.0] - 2016-12-13
343+
### Notes
344+
- [:ledger: View full changelog][0.37.0]
289345
### Changed
290346
- Logging improvements to Botan integration.
291347
### Deprecated
292348
- Move `hideKeyboard` to `removeKeyboard`.
293349

294-
[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
350+
[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
295351
[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
296352
[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
297353
[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
@@ -313,6 +369,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
313369
[0.44.0-bc-update-content-type]: https://github.com/php-telegram-bot/core/wiki/Breaking-backwards-compatibility#update-getupdatecontent
314370
[example-bot]: https://github.com/php-telegram-bot/example-bot
315371
[PSR-3]: https://www.php-fig.org/psr/psr-3
372+
[Tidelift]: https://tidelift.com/subscription/pkg/packagist-longman-telegram-bot?utm_source=packagist-longman-telegram-bot&utm_medium=referral&utm_campaign=changelog
316373

317374
[Unreleased]: https://github.com/php-telegram-bot/core/compare/master...develop
318375
[0.58.0]: https://github.com/php-telegram-bot/core/compare/0.57.0...0.58.0

0 commit comments

Comments
 (0)