Skip to content

RELEASING.md

Latest commit

 

History

History
41 lines (33 loc) · 2.21 KB

RELEASING.md

File metadata and controls

41 lines (33 loc) · 2.21 KB
Raw

Release checklist

English | 简体中文

Prepare

  • Choose the semantic version and update the version variables at the top of CMakeLists.txt — the single source of truth. mybot_version.h is generated from mybot_version.h.in at configure time; do not edit it directly. Update CHANGELOG.md and example output together.
  • Confirm README and docs/PORTING.md match the actual public APIs and CMake options.
  • Review all third-party changes and THIRD_PARTY_NOTICES.md.
  • Obtain written redistribution authorization for the bundled Agora RTSA binary from Agora (声网) sales/business before including it in a release artifact; the in-repo x86_64 Linux binary stays for the Linux demo. If authorization is unavailable, exclude the binary and document how users supply it via AGORA_SDK_DIR / AGORA_RTC_LIBRARY.
  • Ensure source artifacts include the AOSL submodule content or tell users to run git submodule update --init --recursive (GitHub source archives do not include submodules).
  • Confirm no secret, token, private endpoint, customer data, or generated KV data is tracked.

Verify

cmake -S . -B build-release -DCONFIG_PLATFORM=linux -DMYBOT_ENABLE_ASAN=ON
cmake --build build-release -j
ctest --test-dir build-release --output-on-failure
git diff --check
  • Test 20, 40, and 60 ms packet durations.
  • Run provisioning, pairing, bidirectional audio, hangup, shutdown, and reboot on real hardware.
  • Test network loss, audio-device loss, storage failure, and partial startup failure.
  • Confirm logs and release archives contain no credentials.
  • Confirm HTTPS certificate-chain, hostname, SNI, timeout and trust-store behavior on hardware.
  • Confirm MYBOT_ALLOW_INSECURE_HTTP=OFF in every release configuration.

Publish

  • Create an annotated release tag matching MYBOT_VERSION_STRING (e.g. v1.0.0).
  • Attach source and binary artifacts only after third-party authorization review.
  • Include LICENSE, THIRD_PARTY_NOTICES.md, changelog, and checksums.
  • Publish the GitHub release as a stable release (not marked as a prerelease) and list known limitations.