|
Orbit Framework 2.0.0
A high-performance asynchronous C++20 HTTP server framework.
|
How Orbit is versioned, what each release contains, how to verify a download, and the checklist maintainers follow.
Orbit uses Semantic Versioning with one caveat for 1.x.
1.6.1): bug and security fixes only. No API changes, no behaviour changes beyond the fix.1.7.0): new features, and — because the API is not yet frozen — possibly breaking changes. Every breaking change is listed under "Upgrade notes" in CHANGELOG.md and explained, with before/after code, in migration.md.[[deprecated("use X")]] and documented, and stays for at least one minor release (and at least three months) before removal.ServerConfig), unless the old behaviour was a security vulnerability — those are fixed in any release and called out in the upgrade notes.Not breaking: adding overloads, members, options or headers; internal classes in detail namespaces; anything documented as experimental (currently HTTP/3 and the gRPC wrapper).
Each vX.Y.Z tag runs .github/workflows/release.yml, which attaches to the GitHub release:
| File | What it is |
|---|---|
orbit-framework-X.Y.Z.tar.gz, .zip | Source archives of the tag (git archive) |
orbit-framework-X.Y.Z.spdx.json | SBOM (SPDX 2.3): every vcpkg dependency at the exact version and upstream source used for the release |
SHA256SUMS | SHA-256 of every file above |
*.sigstore.json | Sigstore signature bundle for each file, including SHA256SUMS |
Signatures are keyless: they are tied to the release workflow running on a tag of this repository, and recorded in the public Rekor transparency log.
Verified OK means the file was produced by this repository's release workflow and has not been modified since. (Artifacts rebuilt by a manual run are signed from main rather than the tag, hence both in the pattern.)
Vulnerabilities are reported privately (see SECURITY.md) and tracked as draft GitHub Security Advisories. Fixes land with neutral commit and PR titles. Once the release containing them is published, the advisories are published with that version as the patched version.
release/vX.Y.Z branch:CMakeLists.txt (project(... VERSION X.Y.Z)), vcpkg.json, tools/cli/orbit (GIT_TAG) and the README examples;CHANGELOG.md section, with "Upgrade notes" for anything breaking, and update migration.md;main: CMakeLists.txt.packaging/vcpkg-port: the version, the SHA512 of the tag archive (curl -sL https://github.com/varuns2903/orbit-framework/archive/vX.Y.Z.tar.gz | sha512sum), and drop any patch the new tag already contains;If the workflow failed or a tag needs its artifacts rebuilt, run Release Artifacts manually (Actions → Release Artifacts → Run workflow) with the tag name; it replaces the assets on the existing release.