Hybrid Mount Notify

Hybrid Mount Notify is the Telegram notification helper used by the Hybrid Mount build and release pipeline. It scans output/ for generated ZIP artifacts, collects Git metadata from the current checkout, and sends every package to a Telegram chat or topic.

It is intentionally usable in two ways:

• as a small CLI binary for shell-based automation
• as a Rust library that can be called directly from xtask or other internal tooling

🇨🇳 中文文档

---

Table of Contents

• Design Goals
• Architecture
• Repository Layout
• Environment
• CLI
• Library Integration
• Build
• License

---

Design Goals

1. Single-purpose automation for build artifact delivery.
2. Low ceremony integration from shell scripts, CI workflows, or Rust code.
3. Consistent metadata formatting across branch, commit, and artifact reporting.
4. Small maintenance surface so it can evolve independently from the main repository.

Architecture

The crate is split into two layers:

1. src/lib.rs contains the reusable notification logic.
2. src/main.rs provides a CLI wrapper around that library.

At runtime, the tool:

1. reads Telegram credentials from environment variables
2. scans output/ for all .zip artifacts
3. resolves branch and commit metadata from Git / CI environment
4. uploads each archive to Telegram with an HTML caption

Repository Layout

.
├─ src/lib.rs           # reusable notification API
├─ src/main.rs          # CLI entrypoint
├─ Cargo.toml           # crate metadata and dependencies
├─ Cargo.lock           # locked dependency graph
└─ README*.md           # English and Chinese docs

Environment

Required variables:

Key	Description
TELEGRAM_BOT_TOKEN	Telegram bot token used for upload
TELEGRAM_CHAT_ID	target Telegram chat id

Optional CI metadata:

Key	Description
GITHUB_REPOSITORY	repository shown in commit link
GITHUB_SERVER_URL	GitHub host base URL
GITHUB_REF_NAME	branch or tag name shown in caption

If GitHub variables are missing, the crate falls back to local git commands where possible.

CLI

notify [TOPIC_ID] [EVENT_LABEL]

Examples:

# use default event label
notify

# send into a Telegram topic
notify 37 "Daily Tilling - v3.4.5-123"

The CLI expects the current working directory to contain an output/ folder with at least one .zip artifact. If multiple ZIP files are present, all of them are sent in sorted order.

Library Integration

Example:

use notify::{NotifyRequest, maybe_send_output_dir_notification};

let request = NotifyRequest::new("output", "Daily Tilling - v3.4.5-123")
    .with_topic_id(Some(37));

let sent = maybe_send_output_dir_notification(&request)?;
if !sent {
    eprintln!("Telegram secrets not set, skipping notification");
}

Use send_output_dir_notification when missing credentials should be treated as an error, and maybe_send_output_dir_notification when callers prefer a clean skip.

Build

Prerequisites:

• Rust stable or nightly with edition 2024 support

Commands:

# debug build
cargo build

# optimized build
cargo build --release

License

Licensed under GPL-3.0.