Commit e0cda56
tools: fix incorrect version history order
This fixes an error in parseYAML(text), the version sorting
coudn't be right as we compared an arrify string
(ie. a = ["v18.11, v16.7.0"]) with an array of strings
(ie. b = ["v18.07", "v16.7.0"]) in versionSort(a, b).
minVersion(a) couldn't find the minimum version with an arrify string
like a = ["v18.11, v16.7.0"].
That's why incorrect version history orders sometimes appeared.
Furthermore, no need to sort the added version as it always comes first.
So, it can be the last one to be pushed in the meta.changes array.
Fixes: #45670
Co-authored-by: Luigi Pinca <luigipinca@gmail.com>
PR-URL: #45728
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>1 parent 7438ff1 commit e0cda56
2 files changed
Lines changed: 10 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -79,10 +79,11 @@ const testData = [ | |||
| 79 | 79 | '<div class="api_metadata">' + | |
| 80 | 80 | '<details class="changelog"><summary>History</summary>' + | |
| 81 | 81 | '<table><tbody><tr><th>Version</th><th>Changes</th></tr>' + | |
| 82 | + '<tr><td>v4.2.0</td><td><p>The <code>error</code> parameter can now be' + | ||
| 83 | + 'an arrow function.</p></td></tr>' + | ||
| 82 | 84 | '<tr><td>v5.3.0, v4.2.0</td>' + | |
| 83 | 85 | '<td><p><span>Added in: v5.3.0, v4.2.0</span></p></td></tr>' + | |
| 84 | - '<tr><td>v4.2.0</td><td><p>The <code>error</code> parameter can now be' + | ||
| 85 | - 'an arrow function.</p></td></tr></tbody></table></details></div> ' + | ||
| 86 | + '</tbody></table></details></div> ' + | ||
| 86 | 87 | '<p>Describe <code>Foobar II</code> in more detail here.' + | |
| 87 | 88 | '<a href="http://man7.org/linux/man-pages/man1/fg.1.html"><code>fg(1)' + | |
| 88 | 89 | '</code></a></p></section><section>' + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -325,27 +325,27 @@ function parseYAML(text) { | |||
| 325 | 325 | const removed = { description: '' }; | |
| 326 | 326 | ||
| 327 | 327 | if (meta.added) { | |
| 328 | - added.version = meta.added.join(', '); | ||
| 329 | - added.description = `<span>Added in: ${added.version}</span>`; | ||
| 328 | + added.version = meta.added; | ||
| 329 | + added.description = `<span>Added in: ${added.version.join(', ')}</span>`; | ||
| 330 | 330 | } | |
| 331 | 331 | ||
| 332 | 332 | if (meta.deprecated) { | |
| 333 | - deprecated.version = meta.deprecated.join(', '); | ||
| 333 | + deprecated.version = meta.deprecated; | ||
| 334 | 334 | deprecated.description = | |
| 335 | - `<span>Deprecated since: ${deprecated.version}</span>`; | ||
| 335 | + `<span>Deprecated since: ${deprecated.version.join(', ')}</span>`; | ||
| 336 | 336 | } | |
| 337 | 337 | ||
| 338 | 338 | if (meta.removed) { | |
| 339 | - removed.version = meta.removed.join(', '); | ||
| 340 | - removed.description = `<span>Removed in: ${removed.version}</span>`; | ||
| 339 | + removed.version = meta.removed; | ||
| 340 | + removed.description = `<span>Removed in: ${removed.version.join(', ')}</span>`; | ||
| 341 | 341 | } | |
| 342 | 342 | ||
| 343 | 343 | if (meta.changes.length > 0) { | |
| 344 | - if (added.description) meta.changes.push(added); | ||
| 345 | 344 | if (deprecated.description) meta.changes.push(deprecated); | |
| 346 | 345 | if (removed.description) meta.changes.push(removed); | |
| 347 | 346 | ||
| 348 | 347 | meta.changes.sort((a, b) => versionSort(a.version, b.version)); | |
| 348 | + if (added.description) meta.changes.push(added); | ||
| 349 | 349 | ||
| 350 | 350 | result += '<details class="changelog"><summary>History</summary>\n' + | |
| 351 | 351 | '<table>\n<tr><th>Version</th><th>Changes</th></tr>\n'; | |
0 commit comments