feat(ci): compare builds #517
Merged
+285
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #517 +/- ##
==========================================
- Coverage 80.76% 79.58% -1.19%
==========================================
Files 119 120 +1
Lines 11877 12056 +179
Branches 841 841
==========================================
+ Hits 9593 9595 +2
- Misses 2281 2458 +177
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Web GeneratorPages (66)
|
avivkeller
force-pushed
the
compare-builds
branch
from
6ea1dc1 to
cc0905f
Compare
avivkeller
force-pushed
the
compare-builds
branch
from
7f6e980 to
6e95ec1
Compare
avivkeller
commented
Dec 12, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a build comparison system to automatically analyze and report size changes in generated artifacts for pull requests. The system dynamically discovers comparator scripts and generates markdown reports showing file size differences between base and head branches.
Key Changes:
- Adds a new GitHub Actions workflow that runs after the Generate Docs workflow completes, comparing build outputs between PR head and base
- Implements a web comparator script that analyzes file sizes and generates a formatted comparison report
- Refactors SPECULATION_RULES constant to be pre-stringified, improving performance by eliminating redundant JSON.stringify calls per page
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/compare-builds.yml |
New workflow that orchestrates build comparison by discovering comparators, downloading artifacts from both branches, running comparisons, and posting results to PRs |
scripts/compare-builds/web.mjs |
New comparator script that analyzes web generator output, calculates size differences, and formats results into markdown tables with collapsible sections |
.github/workflows/generate.yml |
Updates artifact naming to remove run ID suffix, enabling consistent artifact names across workflow runs for comparison |
src/generators/web/constants.mjs |
Moves JSON.stringify of SPECULATION_RULES from usage site to definition, improving performance |
src/generators/web/utils/processing.mjs |
Removes redundant JSON.stringify call now that SPECULATION_RULES is pre-stringified |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
araujogui
approved these changes
Dec 12, 2025
flakey5
reviewed
Dec 12, 2025
…to compare-builds
flakey5
approved these changes
Dec 13, 2025
ovflowd
reviewed
Dec 13, 2025
ovflowd
reviewed
Dec 13, 2025
ovflowd
reviewed
Dec 13, 2025
| * @see https://developer.mozilla.org/en-US/docs/Web/API/Speculation_Rules_API | ||
| */ | ||
| export const SPECULATION_RULES = { | ||
| export const SPECULATION_RULES = JSON.stringify({ |
Member
There was a problem hiding this comment.
Suggested change
| export const SPECULATION_RULES = JSON.stringify({ | |
| export const SPECULATION_RULES_STRING = JSON.stringify({ |
Member
There was a problem hiding this comment.
IDK why you made this unrelated change tho... Any reason why calling JSON.stringify right on definition? Not sure we do that with constants.
Member
Author
There was a problem hiding this comment.
IDK why you made this unrelated change tho... Any reason why calling JSON.stringify right on definition? Not sure we do that with constants.
As I mentioned in the comments, I made this change to slightly reduce the build size, showcasing the comparison.
It's on the constant just so that the same stringify isn't called on every page.
Member
There was a problem hiding this comment.
As I mentioned in the comments, I made this change to slightly reduce the build size, showcasing the comparison.
Hmm, how does this reduce build size? Hmmm
Member
There was a problem hiding this comment.
(Also apologies for not notidcing on the comments, I just quickly jumped to the PR)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a system for adding a series of comparators to our codebase.
At the moment, only a
webcomparison is implemented. To add more comparators, add[generator-name].mjsto thescripts/compare-buildsdirectory. These comparators will run on incoming PRs.Example output: #517 (comment)