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

Portable stories: Make setProjectAnnotations accept multiple types of imports #26316

Merged
merged 5 commits into from
Mar 14, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Mar 5, 2024

Closes #

What I did

Before, it was tricky for users to know how to set project annotations because they can either come from a file such as:

1 -

// .storybook/preview.ts
const preview = {
	parameters: {}
}

export default preview;

2 -

// .storybook/preview.ts
export const parameters = {}

Meaning they would have to know whether to import them like so (in a Vitest setup file for instance):

// setup-file.ts
import * as annotations from '../.storybook/preview' // or some-addon/preview
import { setProjectAnnotations } from '@storybook/react'
setProjectAnnotations(annotations)

or like so:

// setup-file.ts
import annotations from '../.storybook/preview' // or some-addon/preview
import { setProjectAnnotations } from '@storybook/react'
setProjectAnnotations(annotations)

It gets tricky because annotations can come differently from where users are importing.

This PR fixes that issue by accepting both formats, and in the documentation we will be telling users to use import * as even if the file has just a default export. This way, the code will always be concise such as:

import * as sbAnnotations from '../.storybook/preview'
import * as addonAnnotations from 'some-addon/preview'
import { setProjectAnnotations } from '@storybook/react'
setProjectAnnotations([sbAnnotations, addonAnnotations])

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

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 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>

@yannbf yannbf added maintenance User-facing maintenance tasks ci:normal portable stories labels Mar 5, 2024
Copy link
Contributor

@JReinhold JReinhold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

code/lib/types/src/modules/story.ts Outdated Show resolved Hide resolved
@yannbf yannbf force-pushed the feature/portable-stories-annotations-improvement branch from 4ba9e6f to f52e691 Compare March 5, 2024 17:49
@storybook-bot
Copy link
Contributor

Failed to publish canary version of this pull request, triggered by @yannbf. See the failed workflow run at: https://github.com/storybookjs/storybook/actions/runs/8160773211

@yannbf yannbf marked this pull request as draft March 6, 2024 09:14
@yannbf yannbf requested a review from ndelangen March 13, 2024 15:54
Copy link

nx-cloud bot commented Mar 13, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8edd503. 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.

@yannbf yannbf marked this pull request as ready for review March 14, 2024 08:51
@yannbf yannbf merged commit 84b39c0 into next Mar 14, 2024
54 of 56 checks passed
@yannbf yannbf deleted the feature/portable-stories-annotations-improvement branch March 14, 2024 09:32
@github-actions github-actions bot mentioned this pull request Mar 14, 2024
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal maintenance User-facing maintenance tasks portable stories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants