Unexpected arrangement of the group headings of the changelog

[jrson83]

Hey it's me again 😁

After building the initial changelogs for the single packages in my monorepo, I notice that the arrangement of the group headings is sorted alphabetically. The repo has not enabled Linear History and I used Merge for my PR's.

I have not found any specification related Conventional Commit Changelog heading order, but this issue conventional-changelog/conventional-changelog-config-spec/issues/36, but I also do not know which changelog conventions your generator follows.

When looking at the most changelogs using Conventional Commit format, Features is the most top heading. I wonder if there is a convention for the heading order, or if it has something todo with the repo setup, or commit order, since when looking at your changelog, it has the right order.

[adam-coster]

I think this is where my sort order is coming from:

jslib/scripts/changelogs.mjs

Line 23 in 49601d7

const groups = Object.keys(version.groups).sort();

[jrson83]

Thank you! I just came up with the simple solution:

const sortOrder = [
  'Features',
  'Code Refactoring',
  'Bug Fixes',
  'Reverts',
  'Builds',
  'Performance Improvements',
  'Styles',
  'Documentation',
  'Tests',
]

// ....
const groups = Object.keys(version.groups).sort(
  (a, b) => sortOrder.indexOf(a) - sortOrder.indexOf(b)
)

[adam-coster]

Perfect!