github-release-notes icon indicating copy to clipboard operation
github-release-notes copied to clipboard

The CHANGELOG.md generation doesn't pull the issues from the milestone

Open TRomesh opened this issue 5 years ago • 3 comments

I'm trying to automate the Release note generation. Here is my grenrc.js .

module.exports = {
  dataSource: "milestones",
  prefix: "",
  milestoneMatch: "Release {{tag_name}}",
  changelogFilename: "CHANGELOG.md",
  ignoreIssuesWith: ["duplicate", "wontfix", "invalid", "help wanted"],
  template: {
    commit: ({ message, url, author, name }) =>
      `- [${message}](${url}) - ${author ? `@${author}` : name}`,
    issue: "- {{labels}} {{name}} [{{text}}]({{url}})",
    label: "[**{{label}}**]",
    noLabel: "closed",
    changelogTitle: "# Changelog\n\n",
    release: "## {{release}} ({{date}})\n{{body}}",
    releaseSeparator: "\n---\n\n",
    group: function (placeholders) {
      var icon = "🙈";
      if (placeholders.heading == "Enhancements") {
        icon = "🚀";
      } else if (placeholders.heading == "Bug Fixes" || "Bugs") {
        icon = "🐛";
      } else if (placeholders.heading == "Documentation") {
        icon = "📚";
      } else if (placeholders.heading == "Technical Tasks") {
        icon = "⚙️";
      }
      return "\n#### " + icon + " " + placeholders.heading + "\n";
    },
  },
  groupBy: {
    "Enhancements:": ["enhancement", "internal"],
    "Bug Fixes:": ["bug"],
  },
};

when i do a release it create a new release in my repo with commits but it doesn't fetch the issues, bugs or any other tags defined. I went through the documentation but i couldn't find on how to get that nice looking report like structure in release notes. I tried to generate the CHANGELOG.MD file using the gren changelog --generate --override but it doesn't fetch any issues or bugs. and this is how my release notes looks

image

Any reason why im not getting the issues on CHANGELOG.MD and inside the Release note.? Im new to gren and git release notes stuff.

TRomesh avatar May 06 '20 09:05 TRomesh

Hello @TRomesh, just to clarify, in your project you have a Milestone called Release v3.13 which contains the issues?

alexcanessa avatar May 11 '20 09:05 alexcanessa

Hi @alexcanessa yes i have a milestone called Release v3.13 which contains issues with labels bugs,enhancements etc

TRomesh avatar May 11 '20 11:05 TRomesh

Ok, this might be related to a recent "fix" which seems to have broken things here and there. I'll keep you posted

alexcanessa avatar May 11 '20 12:05 alexcanessa