Harmonize changelog semver style version and range quoting #6243
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
👷 Deploy request for cypress-docs pending review.Visit the deploys page to approve it
|
|
jennifer-shehane
approved these changes
Aug 11, 2025
|
@jennifer-shehane is attempting to deploy a commit to the Cypress Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Vercel is broken. We're looking into it. |
This comment was marked as resolved.
This comment was marked as resolved.
|
@MikeMcC399 Thanks, some minor confusion on our side as they were both configured at one point. |
This comment was marked as resolved.
This comment was marked as resolved.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Situation
Managing the Release Changelog contains guidelines in the form of linked examples for formatting versions. These have not been consistently followed.
The example for dependency updates is cited as https://docs.cypress.io/app/references/changelog#7-2-0
Some semver style versions (
X.Y.Z) in the Changelog are written in plain text, although they are mostly enclosed in Markdown code backticks.Regressions are inconsistently handled and do not always follow the guidelines in Managing the Release Changelog. Harmonize formatting for existing regression links:
Change
Change all listed semver style version numbers in the Changelog to enclose them in Markdown code backticks, except in headers.
Apply this also to version ranges as used by npm/node-semver.
Add missing links when referring to regressions and harmonize existing links.
Related