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

Build: Move chromatic to scripts directory #26233

Merged
merged 16 commits into from
Mar 13, 2024
Merged

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Feb 28, 2024

What I did

Upgrade the chromatic dependency, and move it to the scripts directory.

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

None needed, I think. Just the CI passing should be enough.

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>

@ndelangen ndelangen changed the base branch from main to next February 28, 2024 13:40
@ndelangen ndelangen self-assigned this Feb 28, 2024
@ndelangen ndelangen added build Internal-facing build tooling & test updates ci:normal labels Feb 28, 2024
@ndelangen ndelangen mentioned this pull request Feb 28, 2024
8 tasks
@storybookjs storybookjs deleted a comment from socket-security bot Feb 28, 2024
@storybookjs storybookjs deleted a comment from socket-security bot Feb 28, 2024
@ndelangen ndelangen marked this pull request as ready for review February 28, 2024 21:12
@storybookjs storybookjs deleted a comment from socket-security bot Feb 29, 2024
code/package.json Outdated Show resolved Hide resolved
@ndelangen ndelangen requested a review from JReinhold March 2, 2024 08:49
@ndelangen ndelangen changed the title Build: Move chromatic to script directory Build: Move chromatic to scripts directory Mar 6, 2024
Copy link

nx-cloud bot commented Mar 11, 2024

☁️ Nx Cloud Report

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

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

LGTM. Can you comment in your PR why we are moving it to the scripts directory? I'm fine with it and it makes sense, but I assume it's solving some specific problem and it's not not 100% obvious what that is.

@@ -47,8 +47,8 @@
"storybook:blocks:build": "STORYBOOK_BLOCKS_ONLY=true yarn storybook:ui:build",
"storybook:blocks:chromatic": "STORYBOOK_BLOCKS_ONLY=true yarn storybook:ui:chromatic --project-token=${CHROMATIC_TOKEN_STORYBOOK_BLOCKS:-MISSING_PROJECT_TOKEN}",
"storybook:ui": "NODE_OPTIONS=\"--preserve-symlinks --preserve-symlinks-main\" ./lib/cli/bin/index.js dev --port 6006 --config-dir ./ui/.storybook",
"storybook:ui:build": "NODE_OPTIONS=\"--preserve-symlinks --preserve-symlinks-main\" ./lib/cli/bin/index.js build --config-dir ./ui/.storybook",
"storybook:ui:chromatic": "yarn chromatic --build-script-name storybook:ui:build --storybook-config-dir ./ui/.storybook --storybook-base-dir ./code --project-token=${CHROMATIC_TOKEN_STORYBOOK_UI:-MISSING_PROJECT_TOKEN} --only-changed --exit-zero-on-changes --exit-once-uploaded",
"storybook:ui:build": "NODE_OPTIONS=\"--preserve-symlinks --preserve-symlinks-main\" ./lib/cli/bin/index.js build --config-dir ./ui/.storybook --webpack-stats-json",
Copy link
Member

@shilman shilman Mar 12, 2024

Choose a reason for hiding this comment

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

Can we use --stats-json now in 8.0?

Copy link
Member Author

Choose a reason for hiding this comment

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

@ethriel3695 Can we change this, as @shilman requests?

Copy link
Contributor

Choose a reason for hiding this comment

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

@ndelangen @shilman We are good to replace the flag with --stats-json

@ndelangen
Copy link
Member Author

LGTM. Can you comment in your PR why we are moving it to the scripts directory? I'm fine with it and it makes sense, but I assume it's solving some specific problem and it's not not 100% obvious what that is.

It's consistent with how we run other scripts.

The general idea is to move packages we use to maintain storybook to the scripts dir as much as possible, so that those cannot conflict version wise with the packages that make up storybook.

@ndelangen ndelangen merged commit 205970f into next Mar 13, 2024
55 checks passed
@ndelangen ndelangen deleted the norbert/upgrade-chromatic branch March 13, 2024 14:37
@github-actions github-actions bot mentioned this pull request Mar 13, 2024
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Internal-facing build tooling & test updates ci:normal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants