Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Release Checklist

这份清单记录当前 0.8.x 发布时需要执行的步骤。

CHANGELOG.md 只记录版本结果;具体发布动作统一记在这里。

发布前

  1. 确认 CHANGELOG.mdREADME.mddocs/ 已对齐当前代码
  2. 确认根 crate 和 orion-error-derive 的版本号一致
  3. 运行:
    • cargo fmt --all
    • cargo clippy --all-targets --all-features -- -D warnings
    • cargo test --all-features -- --test-threads=1
    • bash scripts/check-feature-matrix.sh
    • bash scripts/check-doc-code.sh
    • bash scripts/check-v3-policy.sh
    • cargo test --doc --no-default-features
  4. 在可联网环境中运行:
    • cargo package --manifest-path orion-error-derive/Cargo.toml
    • cargo package
    • cargo publish --manifest-path orion-error-derive/Cargo.toml --dry-run
    • cargo publish --dry-run

发布前边界确认

发布前还应确认下面这些锁没有失效:

  1. src/lib.rs 的 root surface compile-fail doctest 仍通过
  2. tests/test_layered_exports.rstests/test_versioned_namespaces.rs 仍覆盖当前分层导出边界
  3. README / tutorial / reason identity guide 的代码块仍与当前源码一致
  4. 如果 public surface 有新增或迁移:
    • 先补测试/compile guard
    • 再更新 README / docs
    • 最后更新 changelog

正式发布顺序

  1. 先发布 orion-error-derive
  2. 等 crates.io 索引传播完成
  3. 再发布 orion-error

当前仓库的 GitHub Actions release workflow 已按这个顺序配置。

发布后检查

  1. 确认 crates.io 上两个包版本都可见
  2. 确认 orion-error 的默认 derive feature 能正常解析 orion-error-derive
  3. 确认 docs.rs 页面生成成功:
    • orion-error
    • orion-error-derive