Types: Allow null in value of experimental_updateStatus to clear status
#24206
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…uild-page Closes chromaui/addon-visual-tests#110 (comment) ## What I did - I changed the type-interface of `experimental_updateStatus` so it allows `null` as a value to indicate it should delete the status on a story. The runtime code was already correct. We didn't catch this because `manager-api` is still `strict:false` in `tsconfig.json`. ## Checklist for Contributors ### Testing <!-- Please check (put an "x" inside the "[ ]") the applicable items below to communicate how to test your changes --> #### The changes in this PR are covered in the following automated tests: - [ ] stories - [ ] unit tests - [ ] integration tests - [ ] end-to-end tests #### Manual testing I tested this manually, by changing `strict:false` to `true` and checking if it does not produce an error for that line. TS does produce an error, when I removed the `| null`, so I think that means this change is correct. ### Documentation <!-- Please check (put an "x" inside the "[ ]") the applicable items below to indicate which documentation has been updated. --> - [ ] Add or update documentation reflecting your changes - [ ] If you are deprecating/removing a feature, make sure to update [MIGRATION.MD](https://github.com/storybookjs/storybook/blob/next/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: <details> <summary>Available labels</summary> - `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. </details> ### 🦋 Canary release <!-- CANARY_RELEASE_SECTION --> 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](https://github.com/storybookjs/storybook/actions/workflows/canary-release-pr.yml) or locally with `gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>`_ <!-- CANARY_RELEASE_SECTION -->
ndelangen
changed the title
null in value of experimental_updateStatus to clear status
ndelangen
added
bug
patch:yes
storybook-bot
pushed a commit
that referenced
this pull request
Sep 18, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
This was referenced Sep 18, 2023
Merged
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 19, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 20, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 20, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 20, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 20, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
storybook-bot
pushed a commit
that referenced
this pull request
Sep 20, 2023
…atusupdate Types: Allow `null` in value of `experimental_updateStatus` to clear status (cherry picked from commit 2bf4dc5)
github-actions
bot
added
the
patch:done
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes chromaui/addon-visual-tests#110 (comment)
What I did
experimental_updateStatusso it allowsnullas a value to indicate it should delete the status on a story.The runtime code was already correct.
We didn't catch this because
manager-apiis stillstrict:falseintsconfig.json.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
I tested this manually, by changing
strict:falsetotrueand checking if it does not produce an error for that line.TS does produce an error, when I removed the
| null, so I think that means this change is correct.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>