changelog.ts 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. import axios from 'axios';
  2. import _ from 'lodash';
  3. import { Task, TaskRunner } from './task';
  4. const githubGrafanaUrl = 'https://github.com/grafana/grafana';
  5. interface ChangelogOptions {
  6. milestone: string;
  7. }
  8. const changelogTaskRunner: TaskRunner<ChangelogOptions> = async ({ milestone }) => {
  9. const client = axios.create({
  10. baseURL: 'https://api.github.com/repos/grafana/grafana',
  11. timeout: 10000,
  12. });
  13. if (!/^\d+$/.test(milestone)) {
  14. console.log('Use milestone number not title, find number in milestone url');
  15. return;
  16. }
  17. const res = await client.get('/issues', {
  18. params: {
  19. state: 'closed',
  20. per_page: 100,
  21. labels: 'add to changelog',
  22. milestone: milestone,
  23. },
  24. });
  25. const issues = res.data;
  26. const bugs = _.sortBy(
  27. issues.filter(item => {
  28. if (item.title.match(/fix|fixes/i)) {
  29. return true;
  30. }
  31. if (item.labels.find(label => label.name === 'type/bug')) {
  32. return true;
  33. }
  34. return false;
  35. }),
  36. 'title'
  37. );
  38. const notBugs = _.sortBy(issues.filter(item => !bugs.find(bug => bug === item)), 'title');
  39. let markdown = '### Features / Enhancements\n';
  40. for (const item of notBugs) {
  41. markdown += getMarkdownLineForIssue(item);
  42. }
  43. markdown += '\n### Bug Fixes\n';
  44. for (const item of bugs) {
  45. markdown += getMarkdownLineForIssue(item);
  46. }
  47. console.log(markdown);
  48. };
  49. function getMarkdownLineForIssue(item: any) {
  50. let markdown = '';
  51. const title = item.title.replace(/^([^:]*)/, (match, g1) => {
  52. return `**${g1}**`;
  53. });
  54. markdown += '* ' + title + '.';
  55. markdown += ` [#${item.number}](${githubGrafanaUrl}/pull/${item.number})`;
  56. markdown += `, [@${item.user.login}](${item.user.html_url})`;
  57. markdown += '\n';
  58. return markdown;
  59. }
  60. export const changelogTask = new Task<ChangelogOptions>();
  61. changelogTask.setName('Changelog generator task');
  62. changelogTask.setRunner(changelogTaskRunner);