Fix release header sorting #29
Merged
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
|
These bugs were discovered while working on unit tests for #28. See the |
Merged
The release header sorting was broken in two ways. First, the sort function was totally broken - it returned a boolean instead of the expected `-1` or `1`. Second, the release link generation would always consider the _numerical_ previous release to be the previous release for comparison purposes, even if it was released _after_. The sorting function now correctly returns numbers, as `Array.prototype.sort` expects. The release link logic has been updated to ensure the "previous" release is both numerically and chronologically previous as well. We don't yet validate that the releases are sorted chronologically, but that is the assumption for now. We can add validation using release dates at some point in the future.
Gudahtt
force-pushed
the
fix-release-header-sorting
branch
from
6694b19
to
eaa424f
Compare
|
The change in logic here is a bit... nuanced, but the intent was explained in some detail in the inline comments. Please let me know if something is still unclear! |
brad-decker
approved these changes
Apr 20, 2021
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.
The release header sorting was broken in two ways. First, the sort function was totally broken - it returned a boolean instead of the expected
-1or1. Second, the release link generation would always consider the numerical previous release to be the previous release for comparison purposes, even if it was released after.The sorting function now correctly returns numbers, as
Array.prototype.sortexpects. The release link logic has been updated to ensure the "previous" release is both numerically and chronologically previous as well.We don't yet validate that the releases are sorted chronologically, but that is the assumption for now. We can add validation using release dates at some point in the future.