目录 由 DocToc 生成

• Tpfs Logger Port
  • 无需编译即可快速检查源代码
  • 运行构建和测试
  • 运行代码风格检查
  • 运行审计
  • 发布预发布版本
  • 发布版本变更到版本
  • 理解语义版本

Tpfs Logger Port

这是基于 Ports and Adapters 的结构化日志实现，用于透明系统。

tpfs-logger-port 包代表日志的 Ports 定义。

此接口设计得非常易于使用，提供同步和异步日志功能，以及一个非常简单的 log() 方法，只需提供严重性和事件。请注意，最终用户必须将任何感兴趣的事件定义为 tpfs_logger::Serialize 以与该日志库交互。

无需编译即可快速检查源代码

cargo check

运行构建和测试

cargo make build
cargo make test

运行代码风格检查

cargo make lint

运行审计

cargo make audit

发布预发布版本

请参阅版本指南以了解预发布版本： https://gitlab.com/TransparentIncDevelopment/docs/engineering-guide/blob/versioning-proposal/versioning.md

您应该使用预发布版本在不同包中测试概念。但这不是您最终发布版本的目的。有关最终发布的详细信息，请参阅 发布更改到包。

您可以通过找到对应的 GitLab 流水线和点击 manual-publish-prerelease-crate 作业旁边的播放按钮，手动推送分支的预发布版本。随着向 master 的合并，预发布包也将自动发布。

发布版本变更到版本

应通过 语义版本 维护包的版本，并有一些辅助脚本来帮助更新 Cargo.toml 和 Cargo.lock 文件中的版本。这种版本更改可以在 MR 被批准合并之前发生在您的分支上。

请使用以下方法之一

• cargomake publish-patch
• cargomake publish-minor
• cargomake publish-major

为了实际发布更改，应在 MR 合并到 master 后进行。一旦合并，请从 master 拉取并重新基，然后使用脚本助手标记发布。

它看起来像以下这样

git checkout master
git pull
cargo make tag-release
git push --tags

理解语义版本

我们在工程指南中有一些说明：https://gitlab.com/TransparentIncDevelopment/docs/engineering-guide/blob/versioning-proposal/versioning.md

semver的基本原理是，如果只有修复和调整，那么只是增加补丁版本号。如果有功能增加，则是小版本号增加，如果是破坏性变更，则是大版本号增加。优先级设置如下：如果为了破坏性变更而增加大版本号，它将包含任何额外的功能，而无需增加小版本号。小版本号增加的情况也是如此，优先于补丁版本号增加。

例如，如果版本号是1.0.0，并且有一些额外功能以及一些修复，这将更新版本号为1.1.0。