CI runs fmt, clippy and tests. Tag releases build Linux and Windows (mingw cross) artifacts, SHA256SUMS and an Ed25519 signed manifest, then publish via the Gitea API. Helper scripts live in scripts/release, docs in docs/release.md.
10 KiB
Релизы и CI
CI и релизы работают на Gitea Actions. Workflow-файлы лежат в .gitea/workflows/
(каталог .github/workflows не используется).
| Файл | Когда запускается | Что делает |
|---|---|---|
.gitea/workflows/ci.yml |
push, pull request | cargo fmt --check, cargo clippy --all-targets -- -D warnings, cargo test --workspace |
.gitea/workflows/release.yml |
push тега v* |
сборка Linux и Windows, подпись манифеста, создание релиза в Gitea |
Регистрация act_runner
Нужен хотя бы один runner с лейблом ubuntu-latest (Docker на хосте runner'а обязателен).
-
В Gitea откройте Site Administration, Actions, Runners (для всего инстанса) либо Settings, Actions, Runners в репозитории или организации, и нажмите Create new runner. Скопируйте registration token.
-
На хосте runner'а скачайте
act_runnerс https://gitea.com/gitea/act_runner/releases. -
Зарегистрируйте runner:
./act_runner register --no-interactive \ --instance https://git.wihuk.pro \ --token <REGISTRATION_TOKEN> \ --name vnox-runner-1 \ --labels "ubuntu-latest:docker://catthehacker/ubuntu:act-22.04" -
Запустите демон:
./act_runner daemon(рекомендуется systemd-юнит). -
Убедитесь, что в UI runner отображается как Idle.
Замечания:
- В
app.iniGitea должен быть включён раздел[actions] ENABLED = true, а у репозитория включены Actions (Settings, Repository, Enable Repository Actions). - Первая сборка долгая (Slint, GStreamer-биндинги, opus из исходников). Кэш cargo
(
actions/cache) ускоряет последующие. Для сборки нужно около 8 ГБ RAM и 10 ГБ диска. - Workflow ставит зависимости через
apt-get; образcatthehacker/ubuntuработает от root, поэтомуsudoне нужен (скрипты используют его, только если он есть). - Шаги
actions/checkoutиactions/cacheскачиваются с адреса, заданного в[actions] DEFAULT_ACTIONS_URL(по умолчанию GitHub). Если исходящий доступ закрыт, зеркалируйте эти actions в свой Gitea. - Для
actions/cacheнужен cache server act_runner (включён по умолчанию, секцияcacheвconfig.yaml). Без него шаг кэша завершается предупреждением, а сборка идёт дальше.
Секреты и переменные
Settings, Actions, Secrets (репозиторий или организация):
| Имя | Обязателен | Описание |
|---|---|---|
VNOX_RELEASE_SIGNING_KEY |
да | Приватный ключ Ed25519: base64 от сырого 32-байтного seed. Без него релиз-джоба падает и ничего не публикует. |
RELEASE_TOKEN |
нет | Персональный токен Gitea со scope write:repository. Если не задан, используется встроенный GITHUB_TOKEN. Задайте, если у встроенного токена нет прав на создание релизов. |
Settings, Actions, Variables:
| Имя | Описание |
|---|---|
VNOX_MIN_VERSION |
Необязательно. Минимальная поддерживаемая версия клиента, попадает в manifest.json (min_version). По умолчанию 0.0.0. |
Как выпустить релиз
-
Поднимите
versionвCargo.toml(например0.2.0) и обновитеCargo.lock(cargo check). -
В
CHANGELOG.mdпереименуйте раздел[Unreleased]в## [0.2.0] - ГГГГ-ММ-ДД(формат заголовка:## [версия]). Текст раздела станет описанием релиза; пустой или отсутствующий раздел останавливает релиз. -
Закоммитьте, дождитесь зелёного CI и поставьте тег:
git tag v0.2.0 git push origin v0.2.0 -
Workflow
releaseпроверит, что:- задан секрет
VNOX_RELEASE_SIGNING_KEY; - версия тега (без
v) равнаversionвCargo.toml, иначе релиз отклоняется; - в
CHANGELOG.mdесть непустой раздел для этой версии.
- задан секрет
-
Затем он соберёт артефакты, подпишет манифест и создаст релиз в Gitea (сначала как черновик, публикуется после загрузки всех файлов).
Теги с суффиксом (v0.2.0-rc.1) попадают в канал beta и помечаются как pre-release;
остальные идут в канал stable.
Артефакты релиза
vnox-client-<версия>-linux-x86_64.tar.gz: бинарникvnox-client,LICENSE,README.md;vnox-client-<версия>-windows-x86_64.zip:vnox-client.exe,LICENSE,README.md(кросс-компиляция из Linux, targetx86_64-pc-windows-gnu, mingw-w64);SHA256SUMS: хэши архивов (sha256sum -c SHA256SUMS);manifest.jsonиmanifest.json.sig: подписанный манифест для апдейтера.
Windows-сборка не включает screen-capture: его зависимости (zbus, GStreamer) объявлены
только для target_os = "linux".
Манифест и подпись
manifest.json записывается в канонической форме: UTF-8, ключи отсортированы, без
пробелов, без перевода строки в конце. manifest.json.sig содержит base64 от подписи
Ed25519 (64 байта) над точными байтами файла manifest.json.
Поля манифеста:
{
"schema": 1,
"product": "vnox-client",
"version": "0.2.0",
"channel": "stable",
"min_version": "0.0.0",
"published_at": "2026-11-01T14:44:21Z",
"artifacts": [
{"platform": "linux-x86_64", "name": "...", "url": "...", "sha256": "...", "size": 123}
]
}
Алгоритм проверки в апдейтере:
- Скачать
manifest.jsonиmanifest.json.sig. - Проверить подпись Ed25519 над сырыми байтами файла вшитым публичным ключом. Только после успеха разбирать JSON.
- Сравнить
versionс текущей, учестьmin_versionиchannel. - Скачать артефакт для своей платформы, проверить
sizeиsha256, и только потом применять.
Публичный ключ нужно вшить в клиент как константу (например, в модуль апдейтера
src/update/), в виде 32 сырых байт. scripts/release/keygen.py печатает его и в base64,
и в виде готовой Rust-константы RELEASE_PUBLIC_KEY: [u8; 32].
Скрипты scripts/release/
Требуется Python 3 и пакет cryptography (pip install cryptography).
keygen.py: генерирует пару ключей;--private-out FILEпишет seed в файл с правами 0600.manifest.py build|sign|verify: сборка, подпись и проверка манифеста.extract_changelog.py VERSION: выводит разделCHANGELOG.mdдля версии.
Локальная проверка подписи (публичный ключ в base64):
scripts/release/manifest.py verify --manifest manifest.json \
--sig manifest.json.sig --public-key <PUBLIC_KEY_B64>
Генерация и ротация ключа
Первичная генерация:
python3 -m pip install cryptography
scripts/release/keygen.py --private-out vnox-release.key
- Содержимое
vnox-release.keyсохраните в секретVNOX_RELEASE_SIGNING_KEY. - Файл ключа уберите в менеджер паролей или офлайн-хранилище и удалите с рабочей машины. Никогда не коммитьте его.
- Публичный ключ (вывод скрипта) вшейте в клиент и выпустите релиз с ним.
Ротация (плановая или при компрометации):
- Сгенерируйте новую пару ключей.
- Плановая ротация: выпустите релиз, подписанный старым ключом, в который вшиты оба
публичных ключа (старый и новый; апдейтер принимает подпись любого из них). Когда
большинство пользователей обновилось, замените секрет
VNOX_RELEASE_SIGNING_KEYна новый ключ и выпускайте релизы уже им, затем удалите старый публичный ключ из клиента в одном из следующих релизов. - Компрометация: сразу замените секрет, отзовите (удалите) релизы, подписанные скомпрометированным ключом. Клиенты со старым ключом без нового публичного ключа придётся обновлять вручную, поэтому держите в клиенте запасной публичный ключ заранее.
- После смены секрета проверьте подпись следующего релиза скриптом
manifest.py verify.