Skip to content

Request: Generate GroupBy Object Array items in order as listed #273

Description

@samkatakouzinos

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"
}

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions