chore: compare compiled output fixes #3616

castastrophe · 2025-03-12T14:07:22Z

Description

This cleans up a bit of the rendering for the compiled compare tool that lets us see any changes to the compiled output so that changes caused by updates to tooling do not get missed during review.

Why does this update remove the netlify.toml?

To build this view for PRs separately from our storybook deploy, we need to maintain different base directories and commands in netlify. This is done more easily in the Netlify UI than it is handled in our local *.toml asset. It also adds an additional layer of security to ensure updates made to these configs are handled by authenticated users.

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

yarn compare Expect this command to build all CSS components and open an HTML preview listing file sizes with a badge identifying components with changes. Components will be listed on the side navigation for easier navigation through all the data.

To-do list

I have read the contribution guidelines.
[n/a] I have updated relevant storybook stories and templates.
[n/a] I have tested these changes in Windows High Contrast mode.
[n/a] If my change impacts other components, I have tested to make sure they don't break.
If my change impacts documentation, I have updated the documentation accordingly.
✨ This pull request is ready to merge. ✨

changeset-bot · 2025-03-12T14:07:27Z

🦋 Changeset detected

Latest commit: 87df661

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@spectrum-tools/gh-action-file-diff	Major
@spectrum-css/search	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2025-03-12T14:12:30Z

File metrics

Summary

Total size: 2.25 MB^*

🎉 No changes detected in any packages

* Size is the sum of all main files for packages in the library.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

github-actions · 2025-03-12T14:13:24Z

🚀 Deployed on https://pr-3616--spectrum-css.netlify.app

castastrophe · 2025-03-12T15:09:24Z

.github/actions/file-diff/index.js

@@ -331,22 +331,16 @@ async function run() {
 				0
 			);
 			core.setOutput("total-size", headMainSize);
-
-			if (hasBase) {


We want to output the has-changed value whether there's a base or not - this ensures has-changed is reflected every time this script is run and the logic matches that used above to report in the comment if changes occurred.

castastrophe · 2025-03-12T15:13:39Z

.github/workflows/compare-results.yml

@@ -10,6 +10,12 @@ name: Compare
 on:
    workflow_call:
        inputs:
+            deploy-message:


These new variables are passed to Netlify just like the publish-site script does.

castastrophe · 2025-03-12T15:14:23Z

.github/workflows/publish-site.yml

@@ -78,7 +78,6 @@ jobs:
                  publish-dir: dist
                  production-branch: main
                  production-deploy: false
-                  netlify-config-path: ./netlify.toml


Removing this local configuration because it is more securely managed in the Netlify UI than as a locally committed asset.

castastrophe · 2025-03-12T15:14:55Z

.prettierrc

@@ -7,6 +7,13 @@
      "options": {
        "printWidth": 500
      }
+    },
+    {


Standardizing the Github Action spacing to mimic more what we have in use today and to align with a lot of the examples for GitHub Actions that exist.

castastrophe · 2025-03-12T15:15:25Z

nx.json

@@ -102,7 +102,7 @@
 		},
 		"compare": {
 			"cache": true,
-			"dependsOn": ["build"],
+			"dependsOn": ["build", { "projects": ["bundle"], "target": "build" }],


The compare tool uses the bundle to style the interface.

castastrophe · 2025-03-12T15:16:41Z

tasks/compare-compiled-output.js

@@ -306,7 +300,6 @@ async function processComponent(
 }

 async function processFile(filename, localPath, comparePath) {
-	const componentName = localPath.split("/")[localPath.split("/").length - 2];


Unused variable

castastrophe · 2025-03-12T15:17:21Z

tasks/compare-compiled-output.js

@@ -371,13 +363,34 @@ async function main(

 	cleanAndMkdir(pathing.latest);

+	const promises = [];


This moves the rendering assets to the .diff-output folder so it can be hosted together on Netlify.

castastrophe · 2025-03-12T15:17:52Z

tasks/compare-compiled-output.js

@@ -480,11 +493,11 @@ async function main(

 	if (!hasAnyChange) {
 		log.write(`\n${"✓".green}  No changes detected.\n`);
-		return Promise.resolve();


Removing this lets the build continue with the web view whether changes are detected or not.

Co-authored-by: rise-erpelding <[email protected]> Co-authored-by: [ Cassondra ] <[email protected]>

castastrophe force-pushed the chore-compare-compiled-output branch 6 times, most recently from 809c192 to 05bfea3 Compare March 12, 2025 15:07

castastrophe commented Mar 12, 2025

View reviewed changes

castastrophe force-pushed the chore-compare-compiled-output branch 4 times, most recently from 99448c8 to 9afcbe6 Compare March 12, 2025 20:06

castastrophe force-pushed the main branch from d829abb to 7e2624a Compare March 12, 2025 20:11

castastrophe force-pushed the chore-compare-compiled-output branch from 9afcbe6 to dafd056 Compare March 12, 2025 20:44

castastrophe force-pushed the main branch 10 times, most recently from c68f4e3 to d2272ea Compare March 12, 2025 21:56

castastrophe force-pushed the chore-compare-compiled-output branch 2 times, most recently from 92504d4 to 489c55a Compare March 12, 2025 23:07

castastrophe self-assigned this Mar 12, 2025

castastrophe added the size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete. label Mar 12, 2025

castastrophe added wip This is a work in progress, don't judge. skip_vrt Add to a PR to skip running VRT (but still pass the action) low priority Not a critical update or fix; can be deprioritized if necessary labels Mar 12, 2025

castastrophe force-pushed the chore-compare-compiled-output branch 7 times, most recently from e42e913 to d1b088b Compare March 13, 2025 19:57

TarunAdobe and others added 3 commits March 18, 2025 14:24

fix(search): update disabled state in spectrum two (#3593)

c4d12c7

Co-authored-by: rise-erpelding <[email protected]> Co-authored-by: [ Cassondra ] <[email protected]>

chore: compare compiled output fixes

872fe4f

chore: align prettier with standard github action settings

87df661

castastrophe force-pushed the chore-compare-compiled-output branch from d1b088b to 87df661 Compare March 18, 2025 18:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: compare compiled output fixes #3616

chore: compare compiled output fixes #3616

castastrophe commented Mar 12, 2025 •

edited

Loading

changeset-bot bot commented Mar 12, 2025 •

edited

Loading

github-actions bot commented Mar 12, 2025 •

edited

Loading

github-actions bot commented Mar 12, 2025 •

edited

Loading

castastrophe Mar 12, 2025

castastrophe Mar 12, 2025

castastrophe Mar 12, 2025

castastrophe Mar 12, 2025

castastrophe Mar 12, 2025

castastrophe Mar 12, 2025

castastrophe Mar 12, 2025

castastrophe Mar 12, 2025

		@@ -371,13 +363,34 @@ async function main(

		cleanAndMkdir(pathing.latest);

		const promises = [];

chore: compare compiled output fixes #3616

Are you sure you want to change the base?

chore: compare compiled output fixes #3616

Conversation

castastrophe commented Mar 12, 2025 • edited Loading

Description

How and where has this been tested?

Validation steps

To-do list

changeset-bot bot commented Mar 12, 2025 • edited Loading

🦋 Changeset detected

github-actions bot commented Mar 12, 2025 • edited Loading

File metrics

Summary

github-actions bot commented Mar 12, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

castastrophe commented Mar 12, 2025 •

edited

Loading

changeset-bot bot commented Mar 12, 2025 •

edited

Loading

github-actions bot commented Mar 12, 2025 •

edited

Loading

github-actions bot commented Mar 12, 2025 •

edited

Loading