You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/send-notification-flow.md
+41-8Lines changed: 41 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,11 +17,13 @@ The git repository sends a webhook to the bot if any event occurs. The webhook c
17
17
### The bot processes the webhook message
18
18
19
19
When an application receives a webhook message from the git repository, the bot processes the webhook message.
20
-
It checks if the webhook is set or not. If the event has any actions and the event is allowed notify in the settings, etc.
20
+
It checks if the webhook is set or not. If the event has any actions and the event is allowed notify in the settings,
21
+
etc.
21
22
22
23
### The bot gets the message details if the event is valid
23
24
24
-
If the event/action is valid, the bot will get the message details of this event/action and set the message details to the message
25
+
If the event/action is valid, the bot will get the message details of this event/action and set the message details to
26
+
the message
25
27
object.
26
28
27
29
### The bot sends a notification
@@ -51,8 +53,9 @@ the `telegram-git-notifier` functionality, including configuration and views for
51
53
52
54
> [!NOTE]
53
55
> The following diagram is a simplified version of the entity relationship diagram for the Telegram Git Notifier.
54
-
>
55
-
> The data is **still saved in JSON format**. I don't use database storage because I don't want to **affect any data on your real system**. Its purpose is only to clarify the feature's operating model.
56
+
>
57
+
> The data is **still saved in JSON format**. I don't use database storage because I don't want to **affect any data on
58
+
your real system**. Its purpose is only to clarify the feature's operating model.
56
59
57
60
```mermaid
58
61
erDiagram
@@ -157,7 +160,37 @@ flowchart TD
157
160
log --> endFlow
158
161
```
159
162
160
-
## Future Work
161
-
162
-
In the future, additional flows will be implemented to handle other aspects of the bot's functionality, such as error
163
-
handling, customizing notifications, and sending notifications to multiple users.
163
+
## Code flow
164
+
165
+
Here is the code flow of the Telegram Git Notifier - send notification flow:
0 commit comments