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

Angular: update wrong type for webpackStatsJson in start-storybook schema.json #24494

Merged
merged 4 commits into from
Oct 18, 2023

Conversation

LucaVazz
Copy link
Contributor

@LucaVazz LucaVazz commented Oct 17, 2023

Closes #24512

What I did

In Storybook 7.5.0, the schema for start-storybook has a wrong type set for the webpackStatsJson property.

Either the type needs to be adapted or the default value should be changed / removed.

I went with changing the type, as...:

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

Not covered by automated tests as far as I can tell

Manual testing

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

To be honest I'm not sure how to test this isolated... When starting storybook trough the CLI I can't reproduce this error, it only occurs for me when starting storybook via nx.

(Taken from the PR which introduced the property into the scheme: #24388)

  1. Run a sandbox for an angular template, e.g. yarn task --task sandbox --start-from auto --template angular-cli/default-ts
  2. Try the new flags on both build and dev

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>

@valentinpalkovic valentinpalkovic changed the title update wrong type for webpackStatsJson in start-storybook schema.json Angular: update wrong type for webpackStatsJson in start-storybook schema.json Oct 18, 2023
@valentinpalkovic valentinpalkovic merged commit a5a7747 into storybookjs:next Oct 18, 2023
44 of 47 checks passed
@github-actions github-actions bot mentioned this pull request Oct 18, 2023
11 tasks
@LucaVazz LucaVazz deleted the patch-1 branch October 19, 2023 08:23
@mandarini
Copy link
Contributor

Came here to say that our e2e tests failed due to that! And it was already fixed!!! Magic <3 <3 <3

@LucaVazz
Copy link
Contributor Author

@mandarini In case you are also using nx: I've found a workaround until the new storybook version is released, you can adapt your project.json as follows:

{
  "name": "storybook",
  "$schema": "../node_modules/nx/schemas/project-schema.json",
  // ...
  "targets": {
    "serve": {
      // ...
      "options": {
        // ...
        "webpackStatsJson": "" // 👈 workaround, has the same effect as false but does not trigger type error
      }
    }
  }
}

@valentinpalkovic valentinpalkovic added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 19, 2023
storybook-bot pushed a commit that referenced this pull request Oct 19, 2023
Angular: update wrong type for webpackStatsJson in start-storybook schema.json
(cherry picked from commit a5a7747)
@github-actions github-actions bot mentioned this pull request Oct 19, 2023
5 tasks
@mandarini
Copy link
Contributor

Thank you!!!!

@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Oct 19, 2023
@LucaVazz
Copy link
Contributor Author

Thank you @valentinpalkovic for the fast merge and patch version release 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Property 'webpackStatsJson' does not match the schema. 'false' should be a 'string'.
3 participants