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

Bump Storybook to v6.5.10 and add workaround for heading anchors #285

Merged

Conversation

stephiescastle
Copy link
Member

@stephiescastle stephiescastle commented Aug 5, 2022

Checklist

  • Include a description of your pull request and instructions for the reviewer to verify your work.
  • Link to the issue if this PR is issue-specific.
  • Create/update the corresponding story if this includes a UI component.
  • Create/update documentation. If not included, tell us why.
  • List the environments / browsers in which you tested your changes.
  • Tests, linting, or other required checks are passing.
  • PR has an informative and human-readable title
    • PR titles are used to generate the change log in releases; good ones make that easier to scan.
    • PRs will be broadly categorized in the change log, but for even easier scanning, consider prefixing with a component name or other useful categorization, e.g., "BaseButton: fix layout bug", or "Storybook: Update dependencies".
  • PR has been tagged with a SemVer label and a general category label, or skip-changelog.
    • These tags are used to do the aforementioned broad categorization in the change log and determine what the next release's version number should be.
    • Release Drafter will attempt to do the category labeling for you! Please double-check its work.

Description

Due to a regression in Storybook, our anchor links in mdx no longer work. This PR updates the Storybook version (for good measure), and also adds manual fixes to the broken anchor links via <span id></span>. This is a known issue and has only been fixed in v7-alpha so far.

Instructions to test

  1. npm i
  2. npm run storybook
  3. test anchor links (usually TOC) at the top of some docs pages

Tested in the following environments/browsers:

Operating System

  • macOS
  • iOS
  • iPadOS
  • Windows

Browser

  • Chrome
  • Firefox ESR
  • Firefox
  • Safari
  • Edge

@github-actions github-actions bot added bug Something isn't working maintenance The meta work of maintaining the project storybook This issue relates to Storybook.js labels Aug 5, 2022
@stephiescastle stephiescastle added the patch Contains bug fixes or maintenance work label Aug 5, 2022
@stephiescastle stephiescastle changed the title bumping to storybook v6.5.10 and adding span ids as a temporary fix f… Bump Storybook to v6.5.10 and adding workaround for heading anchors Aug 5, 2022
@stephiescastle stephiescastle changed the title Bump Storybook to v6.5.10 and adding workaround for heading anchors Bump Storybook to v6.5.10 and add workaround for heading anchors Aug 5, 2022
@stephiescastle stephiescastle merged commit ca7ff75 into main Aug 5, 2022
@stephiescastle stephiescastle deleted the chore/bump-storybook-6.5.10-and-anchor-link-workaround branch August 5, 2022 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working maintenance The meta work of maintaining the project patch Contains bug fixes or maintenance work storybook This issue relates to Storybook.js
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants