Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CSF: Make initialGlobals change only on the external API #28161

Closed

Conversation

shilman
Copy link
Member

@shilman shilman commented Jun 10, 2024

Closes N/A
Telescopes on #27517

What I did

Update #27517 to use initialGlobals for the external API, but continue to use X.globals as the internal return type from normalizeGlobals.

Also return both X.globals AND X.initialGlobals from composeConfigs for backwards compatibility.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

  1. Create a sandbox that sets initialGlobals in its .storybook/preview.js.
  2. Change it to globals and verify that everything still works.

Documentation

Intentionally leaving this undocumented for now. The preview.js globals annotation was also undocumented.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@shilman shilman added maintenance User-facing maintenance tasks core csf ci:normal labels Jun 10, 2024
Copy link

nx-cloud bot commented Jun 10, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 314c3b0. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@shilman shilman self-assigned this Jun 10, 2024
@shilman shilman closed this Jun 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal core csf maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant