Use Rsdoctor in CI/CD

[easy1090]

In CI/CD, there is often a desire to upload historical reports to the CDN as historical records. Because it's not convenient to achieve instant use in the standard mode, the Brief mode is supported.

Brief mode

In brief mode, data reports are integrated into a single HTML page, making it easy for users to view historical build data in a summary form within CI/CD and other scenarios.

Enabling Brief Mode#
You can enable Brief mode by configuring the mode.brief option in the Rsdoctor plugin. After the build, Brief mode will generate a report in the build output directory: [outputDir]/.rsdoctor/report-rsdoctor.html. You can view the build analysis summary by opening the HTML file in a browser.

In brief mode, no code data is displayed to prevent the page from crashing due to large data sizes.

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

module.exports = {
  // ...
  plugins: [
    process.env.RSDOCTOR &&
      new RsdoctorRspackPlugin({
        // other options
        mode: 'brief',
      }),
  ].filter(Boolean),
};

This feature need @rsdoctor/* > 0.4.0.
More details: https://rsdoctor.dev/guide/start/cicd

Next todo in CI/CD

When a repository uses the Rsdoctor plugin during the build process, Rsdoctor will support actions that display the report. In future actions, bundle diff support will be added.