#CI/CD 使用教程

CI/CD 中，往往想要上报历史报告到 CDN 作为历史记录，因为普通模式下无法便捷的做到即开即用，所以支持了 Brief 模式。

#Brief 模式

Brief 模式中，会将数据报告整合到一个 HTML 页面中，方便用户在 CI/CD 及其他方试下使用简报来查看历史构建数据。

#开启 Brief 模式

通过配置 Rsdoctor 插件的 mode.brief 选项，即可开启 Brief 模式。Brief 模式会在构建后生成一份报告到构建产物目录中： [outputDir]/.rsdoctor/report-rsdoctor.html，通过浏览器打开 HTML 文件， 即可看到构建分析简报。

• Brief 模式下是不展示任何的代码数据的，为了防止数据过大导致页面崩溃。
• 报告输出的目录和文件名可配置，可参考：Options。
• 更多配置可参考：Options。

const { RsdoctorRspackPlugin } = require('@rsdoctor/rspack-plugin');

module.exports = {
  // ...
  plugins: [
    // 仅在 RSDOCTOR 为 true 时注册插件，因为插件会增加构建耗时
    process.env.RSDOCTOR &&
      new RsdoctorRspackPlugin({
        // 其他插件选项
        mode: 'brief',
      }),
  ].filter(Boolean),
};

#Brief 模式和 lite 模式的区别

目前 Rsdoctor 有几种报告模式：Normal、Brief 和 Lite。

• normal 模式： 在构建产物目录中生成一个 .rsdoctor 文件夹，其中包含各种数据文件，并在报告页面中展示代码。输出目录可以通过 reportDir 进行配置。

• brief 模式： 在构建产物目录的 .rsdoctor 文件夹中生成一个 HTML 报告文件，所有构建分析数据会整合注入到这个 HTML 文件中，可以通过浏览器打开该 HTML 文件查看报告。brief 模式还有更多配置项，详细信息请参阅：brief.

• lite 模式： 基于普通模式，不展示源码和产物代码，仅显示打包后的代码信息。

  • lite 模式即将在 V2 废弃，参考 lite 模式废弃说明。