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

Docs: Fix providerImportSource extension #26868

Merged

Conversation

bashmish
Copy link
Contributor

What I did

Added extension to the path which is needed in my builder
More info: modernweb-dev/web#2703

Checklist for Contributors

Testing

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

N/A

Manual testing

I tested in my repo by manually adding an extension.

Documentation

N/A

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>

@@ -5,7 +5,7 @@ export * from '@storybook/addon-docs/dist/preset';
export const mdxLoaderOptions = async (config: any) => {
config.mdxCompileOptions.providerImportSource = join(
dirname(require.resolve('@storybook/addon-docs/package.json')),
'/dist/shims/mdx-react-shim'
'/dist/shims/mdx-react-shim.mjs'
Copy link
Contributor Author

@bashmish bashmish Apr 17, 2024

Choose a reason for hiding this comment

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

This exact line is causing a bug for me.
I was wondering why do you even need to override providerImportSource in this @storybook/addon-essentials preset? I mean wouldn't providerImportSource be covered for webpack and vite builder by 2 other files? Maybe instead of fixing it by providing the extension it's better to remove this entire override in this file? I have a setup similar to vite where this is already provided by the builder, so not sure why addon (especially the essentials addon) is overriding this.

Copy link
Member

Choose a reason for hiding this comment

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

@ndelangen could you provide the context here? Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Uhm... don't have the context why it's needed, though I think @JReinhold probably does.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree that this doesn't look necessary to me. You can try removing it and see if CI still works.

Copy link

nx-cloud bot commented Apr 17, 2024

☁️ Nx Cloud Report

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

@ndelangen ndelangen requested a review from JReinhold April 29, 2024 10:25
@ndelangen ndelangen changed the title fix providerImportSource extension Docs: Fix providerImportSource extension Apr 29, 2024
@bashmish
Copy link
Contributor Author

bashmish commented Apr 29, 2024

@ndelangen thanks for looking into this!
can you backport this to 7.x.x? I can make a PR

@ndelangen ndelangen added the patch:yes Bugfix & documentation PR that need to be picked to main branch label May 1, 2024
@shilman
Copy link
Member

shilman commented May 4, 2024

Hi @bashmish! Thanks so much for fixing this. We have lots of PRs and our workflow is set up to release A.B.C and A.(B+1).0-$prerelease.D in a streamlined way. So we could conceivably patch this back to 8.0.x but not to 7.0.x without invoking a special case. We typically only do this for severe bugs or security issues. My preference would be to merge this (once it's ready) and release it in 8.1.0-alpha.x and then release it in 8.1.0 in a week or so unless there are important reasons to do otherwise. Please let me know what you think! cc @ndelangen

@bashmish
Copy link
Contributor Author

bashmish commented May 4, 2024

@shilman thanks for clear explanation, too bad, but fine by me, I implemented a workaround on my side and will keep it for 7.x.x then.

Given the answer in #26868 (comment), I'd like to try fixing this as discussed in that thread, because it seems more future proof to me for custom builders. So i'm going to update this PR.

UPDATE: on a second thought, let's keep this PR as is and release it, it's a good fix on its own. Removing the other code might take a while for everything to go through, so it's best to keep it in a separate PR for later.

@shilman shilman added bug and removed patch:yes Bugfix & documentation PR that need to be picked to main branch labels May 5, 2024
@shilman shilman merged commit 858973b into storybookjs:next May 5, 2024
61 of 63 checks passed
@github-actions github-actions bot mentioned this pull request May 5, 2024
44 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants