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

Types: Allow null in value of experimental_updateStatus to clear status #24206

Merged
merged 1 commit into from
Sep 18, 2023

Commits on Sep 18, 2023

  1. Merge pull request #24160 from pure-js/docs-add-pnpm-option-to-vite-b…

    …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 committed Sep 18, 2023
    Configuration menu
    Copy the full SHA
    f395933 View commit details
    Browse the repository at this point in the history