github-tools / github-tools/github-release-notes

Request: Generate GroupBy Object Array items in order as listed

Open
#273 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
897
Forks
313
PR merge metrics
No merged PRs in 30d

Description

REQUEST: I would like Object Array items generated the order they are listed.

I use Pull Requests to create releases and changelogs.

I understand that currently;
- groupBy Objects are generated in the order they are listed.
- groupBy Object Arrays are generated alphabetically.

Below is my configuration. For groupBy "Database" Object, I'd like "vehicle" items then "maintain" items generated in the order as listed.
Instead I always get "maintain" first because of alphabet.

```
module.exports = {
"dataSource": "prs",
"ignoreIssuesWith": [
"wontfix",
"duplicate"
],
"prefix": "",
"onlyMilestones": false,
"groupBy": {
"Housekeeping": ["internal"],
"Database": ["vehicle", "maintain"],
"Enhancements": ["enhancement"],
"Bug Fixes": ["bug"],
"null": ["null"]
},
"template": {
commit: ({ message, url, author, name }) => `- [${message}](${url}) - ${author ? `@${author}` : name}`,
issue: "- {{labels}} {{name}} [{{text}}]({{url}})",
label: "[**{{label}}**]",
noLabel: "closed",
group: "\n#### {{heading}}\n",
changelogTitle: "# Changelog\n\n",
release: "## {{release}} ({{date}})\n{{body}}",
releaseSeparator: "\n---\n\n"
},
"changelogFilename": "CHANGELOG.md"
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.