Use Rsdoctor in CI.

[yifancong]

We have already implemented the brief mode, but it is still not very convenient for use in CI. To achieve this goal, Rsdoctor will continue to address the related issues.

---

Motivation

Although the brief mode provides a concise summary of build results, its integration into modern CI/CD pipelines is not yet intuitive or automated. In a typical workflow, developers and reviewers need quick feedback on build quality and bundle changes, especially in pull requests. Improving Rsdoctor's CI/CD support will help teams:

• Detect performance regressions early.
• Visualize bundle differences between branches or commits.
• Share and track reports more conveniently.
• Facilitate automated quality gates in CI.

---

Goals

1. Enable uploading and sharing of analysis reports via Rsdoctor's official website.
2. Automate generation and transfer of report data in CI/CD workflows.
3. Provide GitHub Actions for seamless Rsdoctor integration and diff reporting in pull requests.
4. Show build info and rule scan alerts directly in CI.
5. Visualize bundle diffs in CI/CD to help reviewers understand the impact of changes.

---

Next todo in CI/CD

1. Support uploading JSON reports to the Rsdoctor official website and displaying the reports

• Support uploading Rsdoctor analysis reports (in JSON format) generated in CI/CD to the official website, generating independent and shareable links for team members to view and discuss.

2. Facilitate the generation of transferable and uploadable report data

• Provide an API to export analysis results in standard JSON format, making it easy to store, transfer, and upload reports during the CI process.
• Related discussions/issues:
  • #776
  • Discussions/627

3. Develop GitHub Actions to leverage Rsdoctor's diff capabilities in GitHub CI

• Provide an official GitHub Action to automatically run Rsdoctor during PR/CI, generate reports, and upload them to the official website.
• Support bundle diff comparison between the main branch, specified commits, or custom bases, comparing bundle size and rule scan differences.
• Automatically comment in PRs to display the key diff results and report access links.
• Related discussions/issues:
  • #1025
  • Discussions/491

3.1 Display current build information in CI

• Display the analysis summary and rule scan alerts of the current build in CI logs and PR pages.
  • For example: bundle size, number of chunks, triggered rules, etc.
• Provide brief information or screenshots for overall and bundle pages, supporting one-click access to detailed reports.

3.2 Display Bundle Diff in CI (v 1.3)

• Automatically display the bundle diff results between the current build and the baseline (such as the main branch) in CI and PR comments.
• Support visualization of diff results.
• If the bundle size change exceeds the threshold, automatically highlight or add a warning, with support for custom quality gates.

---

Task List

V 1.3

• Support uploading JSON reports to the Rsdoctor official website and displaying the reports
• Facilitate the generation of transferable and uploadable report data
• Display Bundle Diff in CI

---

Open Questions

• Will custom report fields and display content be supported to meet the needs of different teams?
• How will report upload permissions and data security be ensured?

---

Tracking Issues & Discussions

• #776 - Report Data Export/Upload
• #1025 - GitHub Actions Integration
• Discussions/491 - CI/CD Integration RFC
• Discussions/627 - Report Data Structure & API

[antoinetissier]

This would be very helpful for our team 👍
Do you think this will be included in the June release ?

[yifancong]

This would be very helpful for our team 👍 Do you think this will be included in the June release ?

@antoinetissier We have made adjustments to the plan. Other features need to be launched in July, and this point should be launched before mid-August. |

[giavinh79]

Looking forward to this feature, thanks for putting it together!

Wondering if this upcoming bundle-diff feature would also include a way to report what dependencies were changed (i.e. generating a customizable comment on the PR that highlights dependency changes such as adding a new dependency).

[sgarfinkel]

Is it possible to add quality gates based on the rsdoctor reports? For instance, fail a pipeline is non-whitelisted packages are duplicated?