grafana/packages/grafana-toolkit/src/cli/tasks/changelog.ts

// @ts-ignore
import * as _ from 'lodash';
import { Task } from './task';
import GithubClient from '../utils/githubClient';
import difference from 'lodash/difference';
import chalk from 'chalk';
import { useSpinner } from '../utils/useSpinner';

interface ChangelogOptions {
  milestone: string;
}

const filterBugs = (item: any) => {
  if (item.title.match(/fix|fixes/i)) {
    return true;
  }
  if (item.labels.find((label: any) => label.name === 'type/bug')) {
    return true;
  }
  return false;
};

const getPackageChangelog = (packageName: string, issues: any[]) => {
  if (issues.length === 0) {
    return '';
  }

  let markdown = chalk.bold.yellow(`\n\n/*** ${packageName} changelog  ***/\n\n`);
  const bugs = _.sortBy(issues.filter(filterBugs), 'title');
  const notBugs = _.sortBy(difference(issues, bugs), 'title');

  if (notBugs.length > 0) {
    markdown += '### Features / Enhancements\n';
    for (const item of notBugs) {
      markdown += getMarkdownLineForIssue(item);
    }
  }

  if (bugs.length > 0) {
    markdown += '\n### Bug Fixes\n';
    for (const item of bugs) {
      markdown += getMarkdownLineForIssue(item);
    }
  }

  return markdown;
};

const changelogTaskRunner = ({ milestone }: ChangelogOptions) =>
  useSpinner('Generating changelog', async () => {
    const githubClient = new GithubClient();
    const client = githubClient.client;

    if (!/^\d+$/.test(milestone)) {
      console.log('Use milestone number not title, find number in milestone url');
      return;
    }

    let res = await client.get('/issues', {
      params: {
        state: 'closed',
        per_page: 100,
        labels: 'add to changelog',
        milestone: milestone,
      },
    });

    const data: any[] = res.data;

    while (res.headers.link) {
      const links = parseLink(res.headers.link);
      if (links.next) {
        res = await client.get(links.next);
        data.push(...res.data);
      } else {
        break;
      }
    }

    const mergedIssues = [];
    for (const item of data) {
      if (!item.pull_request) {
        // it's an issue, not pull request
        mergedIssues.push(item);
        continue;
      }
      const isMerged = await client.get(item.pull_request.url + '/merge');
      if (isMerged.status === 204) {
        mergedIssues.push(item);
      }
    }
    const issues = _.sortBy(mergedIssues, 'title');

    const toolkitIssues = issues.filter((item: any) =>
      item.labels.find((label: any) => label.name === 'area/grafana/toolkit')
    );
    const grafanaUiIssues = issues.filter((item: any) =>
      item.labels.find((label: any) => label.name === 'area/grafana/ui')
    );

    let markdown = '';

    markdown += getPackageChangelog('Grafana', issues);
    markdown += getPackageChangelog('grafana-toolkit', toolkitIssues);
    markdown += getPackageChangelog('grafana-ui', grafanaUiIssues);

    console.log(markdown);
  });

function getMarkdownLineForIssue(item: any) {
  const githubGrafanaUrl = 'https://github.com/grafana/grafana';
  let markdown = '';
  let title: string = item.title.replace(/^([^:]*)/, (_match: any, g1: any) => {
    return `**${g1}**`;
  });
  title = title.trim();
  if (title[title.length - 1] === '.') {
    title = title.slice(0, -1);
  }

  if (!item.pull_request) {
    markdown += '* ' + title + '.';
    markdown += ` [#${item.number}](${githubGrafanaUrl}/issues/${item.number})`;
  } else {
    markdown += '* ' + title + '.';
    markdown += ` [#${item.number}](${githubGrafanaUrl}/pull/${item.number})`;
    markdown += `, [@${item.user.login}](${item.user.html_url})`;
  }

  markdown += '\n';

  return markdown;
}

function parseLink(s: any) {
  const output: any = {};
  const regex = /<([^>]+)>; rel="([^"]+)"/g;

  let m;
  while ((m = regex.exec(s))) {
    const [, v, k] = m;
    output[k] = v;
  }

  return output;
}

export const changelogTask = new Task<ChangelogOptions>('Changelog generator task', changelogTaskRunner);