vox-forge API Reference (generated)

vox-forge

Crate: vox-forge · Version: 0.6.0 · Target: Library (lib.rs)

Platform-agnostic Git forge API for Vox — GitHub, Gitea, Forgejo (GitLab deprecated)

Crate Overview

vox-forge — Platform-agnostic Git forge integration for Vox.

Abstracts Git forges (primarily GitHub) behind a single trait. GitLab is deprecated (2026-06-03) and no longer supported. All forge-specific API logic lives in the per-platform modules below; callers only depend on [GitForgeProvider].

Forge coverage

Forge	Feature flag	API basis	Self-hostable	Status
GitHub	github	REST + GraphQL	Enterprise only	Supported
GitLab	gitlab	REST	✅ CE (free)	Deprecated (2026-06-03) — unsupported, slated for removal

GitLab is no longer supported. The gitlab module is retained behind the (deprecated) gitlab feature and emits a runtime warning when constructed. New integrations must use GitHub.

Platform independence

All internal Vox code uses ChangeRequest instead of “PR” or “MR”.

Features

Feature	Default / Enables
default	—
gitea	—
github	—
gitlab	—

Workspace Dependencies

Dependency	Kind
vox-http-client	Normal

Public API Surface

Modules

Module	Description
error	Error types for forge HTTP/auth/parse failures.
provider	GitForgeProvider trait and registry.
types	Forge-neutral DTOs (change requests, labels, webhooks, …).
github	GitHub REST (api.github.com or Enterprise base URL).
gitlab	GitLab REST API. DEPRECATED (2026-06-03): no longer supported; slated for removal.