ci(galaxy): push previews to the registry #7053

hanspagel · 2025-10-09T09:19:31Z

Problem

Currently, we push the Scalar Galaxy example to the Registry on release, that’s fine. I’d like to see if we can have PR previews for the OpenAPI document, too.

Solution

This PR adds a new workflow, that looks for changes to @scalar/galaxy.

When there’s a change, it pushes the updated OpenAPI document to the Registry.

To avoid conflicts, it’s adding the branch to the version number.

Tasks

we need a way to not make the uploaded file the default right-away (--no-current doesn't seem to work), waiting for the next @scalar/cli release

Checklist

I've gone through the following:

I've added an explanation why this change is needed.
I've added a changeset (pnpm changeset).
I've added tests for the regression or new feature.
I've updated the documentation.

Note

Adds a CI workflow to publish/delete PR preview versions of Galaxy to Scalar Registry and updates the OpenAPI title to indicate PREVIEW.

CI/CD:
- Add .github/workflows/scalar-registry-preview.yml to publish PR previews of @scalar/galaxy to Scalar Registry on opened/synchronize, including version suffix with branch; delete preview on closed.
- Builds @scalar/galaxy only when packages/galaxy/** changes, logs in via SCALAR_API_KEY, and publishes packages/galaxy/dist/latest.yaml with generated preview version.
OpenAPI Docs:
- Update packages/galaxy/src/documents/3.1.yaml info.title to Scalar Galaxy (PREVIEW).

^{Written by Cursor Bugbot for commit 9fa7895. This will update automatically on new commits. Configure here.}

changeset-bot · 2025-10-09T09:19:36Z

⚠️ No Changeset found

Latest commit: 8ccb853

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/workflows/scalar-registry-preview.yml

github-actions · 2025-10-09T09:24:27Z

Scalar Components Snapshot Test Results

152 passed

Details

Open report ↗︎
152 tests across 19 suites
46 seconds
8ccb853

github-actions · 2025-10-09T09:24:47Z

Preview Examples

https://95c518ec-e04f-4c42-b432-4714c8c8445b--scalar-deploy-preview.netlify.app

github-actions · 2025-10-09T09:24:48Z

Preview Storybook

https://19a079d0-a654-425e-97b8-9d543429ac1f--scalar-components.netlify.app

github-actions · 2025-10-09T09:24:49Z

Scalar CDN Snapshot Diff Results

Details

Open report ↗︎
0 tests across 0 suites
unknown
8ccb853
These tests are non-blocking and will not prevent merging of your PR.

Important

These tests detect visual differences between the current PR and the latest CDN build which means they may be affected by other changes in main that haven't been released yet.

They can help determine if the changes in the PR are causing any unexpected visual regressions but may be less helpful in isolating the exact cause. For more details see the readme.

cursor

Bug: Unconditional Preview Deletion Causes API Overhead

The delete-preview job attempts to delete a preview version without first checking if galaxy files were modified in the PR. This can lead to unnecessary API calls and potential workflow failures when no preview was ever published.

.github/workflows/scalar-registry-preview.yml#L56-L81

scalar/.github/workflows/scalar-registry-preview.yml

Lines 56 to 81 in 9fa7895

    
             delete-preview: 
        
               if: github.event.action == 'closed' 
        
               runs-on: blacksmith-4vcpu-ubuntu-2204 
        
               timeout-minutes: 10 
        
               strategy: 
        
                 matrix: 
        
                   node-version: [22] 
        
               steps: 
        
                 - name: Checkout repository 
        
                   uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 
        
                 - name: Extract version and generate preview version 
        
                   working-directory: packages/galaxy 
        
                   run: | 
        
                     VERSION=$(node -p "require('./package.json').version") 
        
                     BRANCH_NAME=$(echo "${{ github.head_ref }}" | sed 's/[^a-zA-Z0-9-]/-/g') 
        
                     PREVIEW_VERSION="${VERSION}-${BRANCH_NAME}" 
        
                     echo "PREVIEW_VERSION=$PREVIEW_VERSION" >> $GITHUB_ENV 
        
                 - name: Login to Scalar Registry 
        
                   run: npx @scalar/cli@latest auth login --token ${{ secrets.SCALAR_API_KEY }} 
        
                 - name: Delete preview version from Scalar Registry 
        
                   run: npx @scalar/cli@latest registry delete --namespace scalar --slug galaxy --version ${{ env.PREVIEW_VERSION }}

.github/workflows/scalar-registry-preview.yml

+    if: github.event.action == 'closed'
+    runs-on: blacksmith-4vcpu-ubuntu-2204
+    timeout-minutes: 10
+    strategy:
+      matrix:
+        node-version: [22]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5
+
+      - name: Extract version and generate preview version
+        working-directory: packages/galaxy
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          BRANCH_NAME=$(echo "${{ github.head_ref }}" | sed 's/[^a-zA-Z0-9-]/-/g')
+          PREVIEW_VERSION="${VERSION}-${BRANCH_NAME}"
+          echo "PREVIEW_VERSION=$PREVIEW_VERSION" >> $GITHUB_ENV
+
+      - name: Login to Scalar Registry
+        run: npx @scalar/cli@latest auth login --token ${{ secrets.SCALAR_API_KEY }}
+
+      - name: Delete preview version from Scalar Registry
+        run: npx @scalar/cli@latest registry delete --namespace scalar --slug galaxy --version ${{ env.PREVIEW_VERSION }}


The fix is to add a permissions block to the delete-preview job within the .github/workflows/scalar-registry-preview.yml file. According to the CodeQL recommendation and the intended actions in delete-preview (no writing to the repository, only Scalar Registry management via CLI), the safest minimal permissions block is:

permissions: contents: read

This should be inserted at the same level as (and directly after) timeout-minutes: 10 for the delete-preview job, mirroring how permissions is set for publish-update-preview. No other changes are needed.

This commit introduces a new GitHub Actions workflow for managing preview versions of the @scalar/galaxy package. The workflow triggers on pull request events, allowing for the automatic building, versioning, and publishing of preview versions to the Scalar Registry. Additionally, it includes a step to delete the preview version when the pull request is closed.

This commit modifies the Scalar Registry Preview workflow to ensure that the Scalar CLI commands use the latest version by appending `@latest` to the CLI commands for login and publish operations. This change enhances compatibility and ensures that the most recent features and fixes are utilized during the workflow execution.

github-actions · 2025-10-30T09:24:20Z

Scalar Registry Preview

https://registry.scalar.com/@scalar/apis/galaxy/0.5.9-ci-galaxy-preview

github-actions · 2025-10-30T09:27:58Z

Scalar References End to End Test Results

61 passed

Details

Open report ↗︎
61 tests across 28 suites
17.7 seconds
8ccb853

Important

These tests include snapshots that may need to be updated if there are intentional changes to the UI components. To update the snapshots run pnpm test:e2e:update in packages/api-reference and commit the changes.

hanspagel self-assigned this Oct 9, 2025

hanspagel requested review from geoffgscott and marclave as code owners October 9, 2025 09:19

This comment was marked as outdated.

Sign in to view

github-advanced-security bot found potential problems Oct 9, 2025

View reviewed changes

.github/workflows/scalar-registry-preview.yml Fixed Show fixed Hide fixed

.github/workflows/scalar-registry-preview.yml Fixed Show fixed Hide fixed

cursor bot reviewed Oct 9, 2025

View reviewed changes

github-advanced-security bot found potential problems Oct 9, 2025

View reviewed changes

hanspagel marked this pull request as draft October 9, 2025 09:53

hanspagel force-pushed the ci/galaxy-preview branch from 86565dc to 93465ac Compare October 13, 2025 10:36

hanspagel added 10 commits October 30, 2025 10:20

chore: fake change to scalar galaxy

f2e104e

feat: push openapi documents without promoting them to current

496080e

feat: add a PR comment

d8ce264

chore: single line command

54b8be0

fix: cli has too many arguments?

4bb9f25

chore: output version before using it (wip)

ca02721

chore: restore old option syntax

bbf105d

feat: use new syntax to not make it the current file

8ccb853

hanspagel force-pushed the ci/galaxy-preview branch from 8b75d5c to 8ccb853 Compare October 30, 2025 09:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ci(galaxy): push previews to the registry #7053

ci(galaxy): push previews to the registry #7053

hanspagel commented Oct 9, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Oct 9, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 9, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 9, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 9, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 9, 2025 •

edited

Loading

Uh oh!

cursor bot left a comment

Uh oh!

Check warning

Copilot Autofix

github-actions bot commented Oct 30, 2025

Uh oh!

github-actions bot commented Oct 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


	delete-preview:
	if: github.event.action == 'closed'
	runs-on: blacksmith-4vcpu-ubuntu-2204
	timeout-minutes: 10
	strategy:
	matrix:
	node-version: [22]

	steps:
	- name: Checkout repository
	uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5

	- name: Extract version and generate preview version
	working-directory: packages/galaxy
	run: \|
	VERSION=$(node -p "require('./package.json').version")
	BRANCH_NAME=$(echo "${{ github.head_ref }}" \| sed 's/[^a-zA-Z0-9-]/-/g')
	PREVIEW_VERSION="${VERSION}-${BRANCH_NAME}"
	echo "PREVIEW_VERSION=$PREVIEW_VERSION" >> $GITHUB_ENV

	- name: Login to Scalar Registry
	run: npx @scalar/cli@latest auth login --token ${{ secrets.SCALAR_API_KEY }}

	- name: Delete preview version from Scalar Registry
	run: npx @scalar/cli@latest registry delete --namespace scalar --slug galaxy --version ${{ env.PREVIEW_VERSION }}

ci(galaxy): push previews to the registry #7053

Are you sure you want to change the base?

ci(galaxy): push previews to the registry #7053

Conversation

hanspagel commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

⚠️ No Changeset found

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Scalar Components Snapshot Test Results

Details

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Scalar CDN Snapshot Diff Results

Details

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Unconditional Preview Deletion Causes API Overhead

Uh oh!

Check warning

Copilot Autofix

github-actions bot commented Oct 30, 2025

Uh oh!

github-actions bot commented Oct 30, 2025

Scalar References End to End Test Results

Details

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hanspagel commented Oct 9, 2025 •

edited

Loading

changeset-bot bot commented Oct 9, 2025 •

edited

Loading

github-actions bot commented Oct 9, 2025 •

edited

Loading

github-actions bot commented Oct 9, 2025 •

edited

Loading

github-actions bot commented Oct 9, 2025 •

edited

Loading

github-actions bot commented Oct 9, 2025 •

edited

Loading