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

core prep script bug fix: replace last 'src', not 1st 'src' in entry file paths #30404

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

boylec
Copy link

@boylec boylec commented Jan 28, 2025

Closes #30403

What I did

Updated core build scripts to replace last occurrence of 'src' with 'dist' instead of first occurrence.

Otherwise, if someone clones the storybook repo (for the purposes of contributing) in a path like /Users/theperson/src/storybook then the core build/prep scripts fail due to some pathing issues on the esbuild compile steps.

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. Clone the repo to a root in a path on your local hard drive that contains 'src' above the root.
  2. Run yarn start and confirm everything builds and runs correctly.

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-storybook/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

@storybookjs/core can we do a canary release of this?

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>

Greptile Summary

Fixed critical path resolution issue in Storybook's core build process by modifying how 'src' to 'dist' path transformations are handled, preventing build failures when Storybook is installed in paths containing 'src'.

  • Added new replaceSrcWithDist utility function in scripts/utils/paths.ts to replace only the last occurrence of 'src'
  • Updated path handling in code/core/scripts/prep.ts to use new utility function
  • Modified code/core/scripts/helpers/generatePackageJsonFile.ts and generateTypesMapperFiles.ts for consistent path transformations
  • Fixed build failures when Storybook repository is located in directories containing 'src' (Issue [Bug]: If 'src' is in the path above the storybook repo core does not build #30403)

💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

5 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile

scripts/utils/paths.ts Outdated Show resolved Hide resolved
scripts/utils/paths.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

5 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile

scripts/prepare/tools.ts Show resolved Hide resolved
scripts/utils/paths.ts Outdated Show resolved Hide resolved
Copy link

nx-cloud bot commented Jan 28, 2025

View your CI Pipeline Execution ↗ for commit 5705ef1.

Command Status Duration Result
nx run-many -t build -c production --parallel=3 ✅ Succeeded 5m 36s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-30 11:01:31 UTC

@boylec boylec changed the title replace last 'src' for core build core prep.ts bug fix: replace last 'src', not 1st 'src' in entry file paths Jan 29, 2025
@boylec boylec changed the title core prep.ts bug fix: replace last 'src', not 1st 'src' in entry file paths core prep script bug fix: replace last 'src', not 1st 'src' in entry file paths Jan 29, 2025
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

5 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: If 'src' is in the path above the storybook repo core does not build
1 participant