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.

Sign up for GitHub

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

Jump to bottom

Fix: Heading ID CI flakiness #7141

Merged
merged 3 commits into from
May 19, 2023
Merged

Fix: Heading ID CI flakiness #7141

merged 3 commits into from
May 19, 2023

Conversation

bholmesdev
Copy link
Contributor

@bholmesdev bholmesdev commented May 19, 2023 •
edited
Loading

Changes

  • Switch from a global headingSlugger to a context variable scoped to the config. Adding arbitrary variables to the Markdoc config was endorced by the Stripe team, who uses a services pattern for context. We've used ctx here.
  • Rename applyDefaultConfig() to setupConfig(). Better captures why this function should be run for each file's transform, and the fact that it sets up context

Testing

Add test for heading cache leaks for documents with the same heading IDs

Docs

N/A

@changeset-bot
Copy link

changeset-bot bot commented May 19, 2023 •
edited
Loading

🦋 Changeset detected

Latest commit: fb31b48

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label May 19, 2023
natemoo-re
natemoo-re approved these changes May 19, 2023
View reviewed changes
Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice tests, this looks good!

@bholmesdev bholmesdev merged commit a9e1cd7 into main May 19, 2023
@bholmesdev bholmesdev deleted the fix/markdoc-heading-ids branch May 19, 2023 18:12
@astrobot-houston astrobot-houston mentioned this pull request May 19, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matthewp matthewp matthewp approved these changes

@natemoo-re natemoo-re natemoo-re approved these changes

Assignees
No one assigned
Labels
pkg: integration Related to any renderer integration (scope)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bholmesdev @matthewp @natemoo-re