Артефакт probe-rs
Портативний бінарний дистрибутив probe-rs-tools — набору інструментів для налагодження embedded-цілей ARM і RISC-V через debug probe (probe-rs, cargo-flash, cargo-embed, сервер DAP). Цей репозиторій використовується Embedbits Platform Artifact Handler для пошуку, завантаження, перевірки та налаштування probe-rs у подальших embedded-проєктах.
Цей репозиторій поділено на три гілки/посилання за ролями: гілка main (master), яку ви зараз читаєте, містить лише цю документацію; скрипти handler містяться в гілці Core, а версіоновані бінарні файли публікуються як GitHub Releases, прив'язані до гілки Bin.
Вміст репозиторію
main / master
└── README.md ← This document — no other content
Core
├── ArtifactConfig.cmake ← Artifact metadata (name, version constraints, asset naming)
└── CMakeProbeRsDefaults.cmake ← probe-rs integration logic (artifact init, version lookup)
Bin (anchor branch — no tracked binary files)
└── (empty commits only; each release tag points here)
Роль у платформі
Цей репозиторій — один із кількох дистрибутивів артефактів у платформі Embedbits. Загальний потік такий:
GitHub (Embedbits)
──────────────────────────────────────────────────────────
Artifact-probe-rs
main / master → README only (this document)
Core → ArtifactConfig.cmake, CMakeProbeRsDefaults.cmake
Bin → Anchor branch (empty commits)
Releases → probe-rs-<version>-<platform>.zip + .hash
tagged Bin/<version>-<platform> (platform: Win / Unix / DarwinARM)
ProbeRsImporter.sh публікує кожну версію probe-rs як GitHub Release з тегом Bin/<version>-<platform>, а не як файл, закомічений у гілку Bin. Сама гілка Bin містить лише порожні якірні коміти, на які вказують теги релізів.
Platform Artifact Handler у подальших проєктах посилається на гілку Core як на Git submodule. Під час конфігурації CMake він зчитує ArtifactConfig.cmake, щоб визначити, який реліз завантажувати, а потім завантажує та перевіряє відповідний ресурс релізу для поточної платформи.
Структура гілок
| Гілка / посилання | Вміст |
|---|---|
main / master | Лише цей README — жодного функціонального вмісту |
Core | Скрипти CMake handler (ArtifactConfig.cmake, CMakeProbeRsDefaults.cmake) для використання артефакту |
Bin | Лише якірна гілка — бінарні файли тут не комітяться |
Тег релізу Bin/<version>-<platform> | GitHub Release із власне бінарним .zip та файлом контрольної суми .hash як ресурсами релізу, для platform ∈ Win, Unix, DarwinARM |
Примітка: Сам протокол Embedbits Artifact Handler не прив'язаний до GitHub Releases — це лише те, як скрипти-імпортери, розміщені на GitHub, публікують бінарні файли. На Git-хостингу без еквівалентного Releases API handler також підтримує пакетовані бінарні файли, закомічені безпосередньо як відстежувані файли в гілці
Binі позначені тегами за версією/платформою (Bin/<version>-<platform>), а не завантажені як ресурси релізу. Handler для CMake прозоро розпізнає обидві форми.
⚠️ Отримання релізу
Бінарні файли не зберігаються як відстежувані файли в Bin — клонуйте гілку Core для скриптів handler, а бінарні файли завантажуйте як ресурси релізу для конкретного тега, а не клонуючи гілку Bin.
# Core handler scripts
git clone --branch Core --single-branch --depth=1 <repository_url> probe-rs-core
# Binary + checksum for one specific version/platform (GitHub Release asset)
gh release download Bin/0.32.0-Unix --repo Embedbits/Artifact-probe-rs --pattern "probe-rs-0.32.0-Unix.*"
Складові
| Компонент | Опис |
|---|---|
probe-rs | Основний CLI: прошивання, запуск, RTT, сервер GDB, сервер DAP, REPL налагоджувача |
cargo-flash | Підкоманда Cargo для збірки та прошивання образу firmware |
cargo-embed | Підкоманда Cargo для збірки, прошивання та запуску з інтерактивною сесією (RTT, defmt, GDB) |
Використання
Артефакт встановлюється автоматично на етапі налаштування артефактів за допомогою:
cmake -P Artifacts/ProbeRs/ArtifactConfig.cmake
Скрипт забезпечує наявність бінарних файлів probe-rs, за потреби розпаковує архів і додає інструмент до системного PATH для наступних кроків збірки/прошивання.
Функції handler
ProbeRs_ArtifactInit(ARTIFACT_BIN_PATH)
Ініціалізує артефакт: знаходить (або завантажує) бінарні файли probe-rs-tools і надає їхню теку bin/ за адресою ARTIFACT_BIN_PATH.
ProbeRs_GetArtifactVersion()
Повертає версію поточних визначених бінарних файлів probe-rs-tools.
Версіонування
Версії артефакту безпосередньо відповідають офіційним версіям релізів probe-rs:
0.29.0, 0.30.0, 0.31.0, 0.32.0, ...
Нові версії публікує ProbeRsImporter.sh у репозиторії GithubArtifactsHandler, який завантажує офіційні бінарні файли probe-rs-tools, пакує їх в архіви .zip із перевіркою SHA-256 і публікує як GitHub Release з тегом Bin/<version>-<platform> — сама гілка Bin просувається лише через порожній якірний коміт, на який вказує тег.
Примітки
- Встановлення не потрібне — бінарні файли портативні та самодостатні.
- Офлайн-використання підтримується після локального кешування артефакту.
- У pipelines Azure DevOps для скорочення часу збірки рекомендовано кешувати теку артефакту.
Ліцензія
probe-rs розповсюджується за ліцензіями MIT License / Apache License 2.0 (подвійне ліцензування). Докладніше: https://github.com/probe-rs/probe-rs/blob/master/LICENSE-MIT
Автори
- Mr.Nobody — embedbits.com
Запрошуємо до співпраці! Будь ласка, відкрийте pull request.