ci: deploy vrts on main branch correctly #5569

TarunAdobe · 2025-06-25T15:28:07Z

Description

Updated CircleCI configuration to ensure Visual Regression Test (VRT) results are properly deployed to Azure blob storage when running on the main branch, not just on pull requests.

Motivation and context

Previously, VRT results were only being deployed for pull requests, but main branch VRT runs were not being deployed to the preview site. This made it difficult to access and review VRT results from main branch builds, which are important for baseline comparisons and debugging.

Related issue(s)

Internal CI/CD improvement for VRT workflow

Screenshots (if appropriate)

N/A

Author's checklist

I have read the CONTRIBUTING and PULL_REQUESTS documents.
I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
I have added automated tests to cover my changes.
I have included a well-written changeset if my change needs to be published.
I have included updated documentation if my change required it.

Reviewer's checklist

Includes a Github Issue with appropriate flag or Jira ticket number without a link
Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
Automated tests cover all use cases and follow best practices for writing
Validated on all supported browsers
All VRTs are approved before the author can update Golden Hash

Manual review test cases

VRT deployment should work on main branch
1. Pushed a test commit to this branch to send vrts to /main path if the branch name matches. check this.
2. vrts are then deployed against /main path suggesting checking for branch name worked. verify the output of this job.
3. Verify VRT results are deployed to https://swcpreviews.z13.web.core.windows.net/main/express-dark-large-rtl/review/

Device review

Did it pass in Desktop?
Did it pass in (emulated) Mobile?
Did it pass in (emulated) iPad?

changeset-bot · 2025-06-25T15:28:11Z

⚠️ No Changeset found

Latest commit: be038e7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

github-actions · 2025-06-25T15:29:53Z

📚 Branch Preview

🔍 Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-5569

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

github-actions · 2025-06-25T15:32:46Z

Tachometer results

Currently, no packages are changed by this PR...

Rajdeepc · 2025-06-26T06:35:54Z

@TarunAdobe How can i verify this? can you create a section on what was the issue and what is the fix for the context?

TarunAdobe · 2025-06-26T06:42:13Z

@TarunAdobe How can i verify this? can you create a section on what was the issue and what is the fix for the context?

Yusss!! will do

Rajdeepc · 2025-06-26T10:58:12Z

.circleci/config.yml

+                          # Get PR number from CircleCI environment
+                          PR_NUMBER=""
+                          if [ -n "$CIRCLE_PULL_REQUEST" ]; then
+                              PR_NUMBER=$(echo $CIRCLE_PULL_REQUEST | sed 's/.*\/pull\///')


Suggested change

PR_NUMBER=$(echo $CIRCLE_PULL_REQUEST | sed 's/.*\/pull\///')

PR_NUMBER=$(echo "$CIRCLE_PULL_REQUEST" | sed 's/.*\/pull\///')

Unquoted variables can break if they contain spaces or special characters

Rajdeepc · 2025-06-26T10:59:42Z

.circleci/config.yml

+                          elif [ -n "$CIRCLE_PR_NUMBER" ]; then
+                              PR_NUMBER="$CIRCLE_PR_NUMBER"
+                              echo "Deploying VRT for PR #$PR_NUMBER"
+                          elif [[ "$CIRCLE_BRANCH" =~ ^pull/[0-9]+$ ]]; then


This line assumes a format that may not always hold. CIRCLE_BRANCH for forked PRs is typically the branch name of the fork, not pull/xxx. You can consider removing if this condition even triggers.

we dont run circleci on forks so idt we need to worry abt this

Rajdeepc · 2025-06-26T11:00:41Z

.circleci/config.yml

+                          elif [ -n "$CIRCLE_PR_NUMBER" ]; then
+                              PR_NUMBER="$CIRCLE_PR_NUMBER"
+                              echo "Deploying HCM VRT for PR #$PR_NUMBER"
+                          elif [[ "$CIRCLE_BRANCH" =~ ^pull/[0-9]+$ ]]; then


same as above

we dont run circleci on forks so idt we need to worry abt this

Rajdeepc · 2025-06-26T11:05:44Z

.circleci/config.yml

+                              # GitHub API fallback
+                              PR_NUMBER=$(curl -s -H "Authorization: Bearer $GITHUB_TOKEN" \
+                                  -H "Accept: application/vnd.github+json" \
+                                  "https://api.github.com/repos/$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME/pulls?head=$CIRCLE_PROJECT_USERNAME:$CIRCLE_BRANCH&state=open" \


GitHub allows multiple PRs from different forks to use the same branch name.This can cause the query to match a different PR from a different user, leading to incorrect PR numbers being picked.

we don't run circleci on forked branches

TarunAdobe · 2025-06-26T12:41:30Z

@TarunAdobe How can i verify this? can you create a section on what was the issue and what is the fix for the context?

Added a test commit to verify that checking for branch name works.
Read the testing description now and it should work

chore: deploy vrts on main branch correctly

d51a075

TarunAdobe requested a review from a team as a code owner June 25, 2025 15:28

Merge branch 'main' into ttomar/vrts-main

90a248c

Rajdeepc requested changes Jun 26, 2025

View reviewed changes

chore: test vrts

be038e7

TarunAdobe requested a review from Rajdeepc June 27, 2025 06:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ci: deploy vrts on main branch correctly #5569

ci: deploy vrts on main branch correctly #5569

TarunAdobe commented Jun 25, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Jun 25, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 25, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 25, 2025

Uh oh!

Rajdeepc commented Jun 26, 2025

Uh oh!

TarunAdobe commented Jun 26, 2025

Uh oh!

Rajdeepc Jun 26, 2025 •

edited

Loading

Uh oh!

Rajdeepc Jun 26, 2025

Uh oh!

TarunAdobe Jun 26, 2025

Uh oh!

Rajdeepc Jun 26, 2025

Uh oh!

TarunAdobe Jun 26, 2025

Uh oh!

Rajdeepc Jun 26, 2025

Uh oh!

TarunAdobe Jun 26, 2025

Uh oh!

TarunAdobe commented Jun 26, 2025

Uh oh!

Uh oh!

	PR_NUMBER=$(echo $CIRCLE_PULL_REQUEST \| sed 's/.*\/pull\///')
	PR_NUMBER=$(echo "$CIRCLE_PULL_REQUEST" \| sed 's/.*\/pull\///')

ci: deploy vrts on main branch correctly #5569

Are you sure you want to change the base?

ci: deploy vrts on main branch correctly #5569

Conversation

TarunAdobe commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and context

Related issue(s)

Screenshots (if appropriate)

Author's checklist

Reviewer's checklist

Manual review test cases

Device review

Uh oh!

changeset-bot bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

github-actions bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Branch Preview

🔍 Visual Regression Test Results

Uh oh!

github-actions bot commented Jun 25, 2025

Tachometer results

Uh oh!

Rajdeepc commented Jun 26, 2025

Uh oh!

TarunAdobe commented Jun 26, 2025

Uh oh!

Rajdeepc Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

TarunAdobe Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

TarunAdobe Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

TarunAdobe Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

TarunAdobe commented Jun 26, 2025

Uh oh!

Uh oh!

TarunAdobe commented Jun 25, 2025 •

edited

Loading

changeset-bot bot commented Jun 25, 2025 •

edited

Loading

github-actions bot commented Jun 25, 2025 •

edited

Loading

Rajdeepc Jun 26, 2025 •

edited

Loading