Skip to content

Commit 150d986

Browse files
committed
docs: migration notes for telegram notification
1 parent e1826b2 commit 150d986

File tree

4 files changed

+45
-1
lines changed

4 files changed

+45
-1
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## 4.29.0 (2024/12/19)
44

5+
:warning: See **Migration notes** in the documentation before upgrading.
6+
57
* Topics support for Telegram notifications (#1308)
68
* Webhook url as secret support for Discord, Slack and Teams notifications (#1302)
79
* Enhance error message for JSON decode response issues for Gotify, ntfy and RocketChat (#1309)

docs/migration/v4.1-to-v4.29.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Diun v4.28 to v4.29
2+
3+
## Telegram `chatdIDs` and `chatIDsFile` attributes change
4+
5+
The `chatIDs` attribute has changed from a list of integers to a list of
6+
strings. If you are using Telegram notifications, you need to update your
7+
configuration file:
8+
9+
!!! example "v4.1"
10+
```yaml
11+
notif:
12+
telegram:
13+
token: aabbccdd:11223344
14+
chatIDs:
15+
- 123456789
16+
- 987654321
17+
```
18+
19+
!!! example "v4.29"
20+
```yaml
21+
notif:
22+
telegram:
23+
token: aabbccdd:11223344
24+
chatIDs:
25+
- "123456789"
26+
- "987654321"
27+
```
28+
29+
The same applies for the `chatIDsFile` attribute content:
30+
31+
!!! example "v4.1"
32+
```json
33+
[123456789,987654321]
34+
```
35+
36+
!!! example "v4.29"
37+
```json
38+
["123456789","987654321"]
39+
```
40+
41+
More information on [Telegram notifications](../notif/telegram.md#configuration) page.

docs/notif/telegram.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Multiple chat IDs can be provided in order to deliver notifications to multiple
3939
* `DIUN_NOTIF_TELEGRAM_TEMPLATEBODY`
4040

4141
!!! example "chat IDs secret file"
42-
Chat IDs secret file must be a valid JSON array like: `[123456789,987654321,"567891234:25","891256734:25;12"]`
42+
Chat IDs secret file must be a valid JSON array like: `["123456789","987654321","567891234:25","891256734:25;12"]`
4343

4444
### `chatIDs` format
4545

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ nav:
145145
- FAQ: faq.md
146146
- Changelog: changelog.md
147147
- Migration:
148+
- Diun v4.1 to v4.29: migration/v4.1-to-v4.29.md
148149
- Diun v4.0 to v4.17: migration/v4.0-to-v4.17.md
149150
- Diun v3 to v4: migration/v3-to-v4.md
150151
- Diun v2 to v3: migration/v2-to-v3.md

0 commit comments

Comments
 (0)