Fix changelog where first release isn't first #76
Conversation
This file contains 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
rekmarks
previously approved these changes
May 24, 2021
src/changelog.ts
Outdated
| @@ -139,20 +139,21 @@ function stringifyLinkReferenceDefinitions( | |||
| // patch releases on older releases can be accomodated. | |||
| const releaseLinkReferenceDefinitions = releases | |||
| .map(({ version }) => { | |||
| let diffUrl; | |||
| if (version === orderedReleases[orderedReleases.length - 1]) { | |||
There was a problem hiding this comment.
My only feedback is that orderedReleases (and really the releases param) could be documented / named such that it's immediately obvious that the releases are sorted in chronological order.
There was a problem hiding this comment.
Good call, I'll rename this
`auto-changelog` will now correctly update and validate changelogs where the first release chronologically is different than the first release numerically. A test has been added to ensure such a changelog is now validated correctly. This test fails on `main`. Fixes #57
Gudahtt
force-pushed
the
fix-backport-release-reference-link-definition
branch
from
69d433e
to
027e394
Compare
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.
auto-changelogwill now correctly update and validate changelogs where the first release chronologically is different than the first release numerically.A test has been added to ensure such a changelog is now validated correctly. This test fails on
main.Fixes #57