Actions: Warn on implicit actions #24856
Conversation
kasperpeulen
requested review from
ndelangen,
JReinhold,
tmeasday,
shilman and
yannbf
as code owners
MIGRATION.md
Outdated
| @@ -310,6 +311,55 @@ | |||
|
|
|||
| ## From version 7.5.0 to 7.6.0 | |||
|
|
|||
| #### Using implicit actions during rendering is deprecated (for example in the play function) | |||
There was a problem hiding this comment.
I would remove (for example in the play function) to shorten the heading. You can explain in the contents.
| throw new ImplicitActionsDuringRendering({ phase: storyRenderer.phase!, name }); | ||
| } else { | ||
| console.warn(dedent` | ||
| We detected that you use an implicit action arg during ${storyRenderer.phase} of your story. |
There was a problem hiding this comment.
Do we also need the story name in this message? Or will it only ever throw on the "current" story? Maybe not with portable stories?
There was a problem hiding this comment.
In docs there is no "current" story so I would say we should include the story id.
There was a problem hiding this comment.
So with portable stories, this will never throw. With docs, we don't know which of the rendered stories used the implicit action. Shall I pass down the story id from the arg enhancer maybe?
| throw new ImplicitActionsDuringRendering({ phase: storyRenderer.phase!, name }); | ||
| } else { | ||
| console.warn(dedent` | ||
| We detected that you use an implicit action arg during ${storyRenderer.phase} of your story. |
There was a problem hiding this comment.
In docs there is no "current" story so I would say we should include the story id.
| // eslint-disable-next-line @typescript-eslint/no-non-null-assertion | ||
| throw new ImplicitActionsDuringRendering({ phase: storyRenderer.phase!, name }); | ||
| } else { | ||
| console.warn(dedent` |
There was a problem hiding this comment.
Maybe we should have a principled way to "warn" with a named error so we don't need to duplicate messages like this?
There was a problem hiding this comment.
Right I will construct the error, and destructure the message.
…it-actions # Conflicts: # MIGRATION.md
What I did
Warn on implicit actions
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake 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/coreteam 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>