Fix: Version numbering automatically updates again #884
Conversation
This file contains hidden or 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
We only conditionally replace this _if_ there is a version number in the code block, because this breaks syntax highlighting. This is kind of a cheap hack, and we should really be replacing the strings with version numbers further upstream before they get broken into syntax highlighting chunks, that way we get to keep both working version numbers, as well as syntax highlighting.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
jdpleiness
approved these changes
Jan 3, 2025
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.
We only conditionally replace this if there is a version number in the
code block, because this breaks syntax highlighting.
This is kind of a cheap hack, and we should really be replacing the
strings with version numbers further upstream before they get broken
into syntax highlighting chunks, that way we get to keep both working
version numbers, as well as syntax highlighting.
I tried messing around with contentlayer to replace these strings further upstream, but I couldn't figure it out within my timeboxed session. Hence leaving this PR as it is, because it's fairly important that correct version numbers be displayed and copied by our customers.
Pull Request approval
You will need to get your PR approved by at least one member of the Sourcegraph team. For reviews of docs formatting, styles, and component usage, please tag the docs team via the #docs Slack channel.